View Issue Details

Jump to NotesJump to History
IDProjectCategoryView StatusDate SubmittedLast Update
0021674Open CASCADEOCCT:Documentationpublic2010-04-11 08:542011-07-12 12:00
ReporterabvAssigned Toabv 
PrioritynormalSeverityfeature 
Status closedResolutionfixed 
OSAll 
Fixed in Version6.4.0 
Summary0021674: Improve generator of reference documentation
DescriptionThe scripts used to generate Doxygen reference documentation for OCCT (located
in unit WOKTclLib) need to be improved in many directions:

1. Use latest version of Doxygen (at least, 1.6.1)
2. Provide on-line search (using Doxygen 1.6.x capabilities)
3. Provide cross-references between modules (via usage of Doxygen tag files).
4. Avoid useless entries in the docs, like Standard_EXPORT or OCCT-specific
operators new()
5. Improve procedure to be easily executable on user side
6. Update Overview documentation to describe procedure of generating docs for
whole OCCT
7. Include Doxygen configuration files used for generation of docs, and
generated tag files, to the documentation distributive
8. Learn to generate documentation for products (keeping references to OCCT
classes)

See also some additional ideas in IFMT 195 ( http://
hrmt.nnov.opencascade.com:8090/IFMT/ViewDetail.jsp?id=195 ). Note that relevant
FIP proposal has been discussed on TC 0000018 and validated.
TagsNo tags attached.
Test case number

Attached Files

  • occ21674-abv-v2.tar.gz (8,294 bytes)
  • occ21674-abv-v3.tar.gz (20,480 bytes)
  • occ21674-abv-v4.tar.gz (3,671 bytes)

Activities

2010-04-11 11:59

 

occ21674-abv-v2.tar.gz (8,294 bytes)

2010-04-12 14:15

 

occ21674-abv-v3.tar.gz (20,480 bytes)

2010-04-15 13:32

 

occ21674-abv-v4.tar.gz (3,671 bytes)

Issue History

Date Modified Username Field Change
2010-04-11 12:12 abv CC => kgv
2010-04-15 11:25 bugmaster CC => apv
2010-04-15 11:25 bugmaster Assigned To bugmaster => abv
2010-04-15 11:25 bugmaster Status new => assigned
2010-04-20 06:32 abv Status assigned => resolved
2010-06-10 20:15 bugmaster Status resolved => tested
2010-06-10 20:15 bugmaster Status tested => verified
2011-08-02 11:19 bugmaster Category OCCT:DOC => OCCT:Documentation