DiscussionsIssue archiveOCCT:Documentation

Archived issue #0026537

It is not possible to generate reference documentation in new structure of OCCT

Open CASCADEOCCT:Documentationclosed9 public notes

Search issues

Description

1. Overview - OK
2. PDF - OK
3. CHM - OK
3. RD - can be generated if only installed includes copied to OCCT root

The same is actual for products.


Steps to reproduce

gendoc.bat -refman

Public activity

9 archived notes

Participants are labeled by their role within this record.

01Commenter 1
Branch [archived branch] has been created by Participant.

[revision removed]


Detailed log of new commits:

Author: ibs
Date: Mon Aug 10 14:50:34 2015 +0300

    0026537: It is not possible to generate reference documentation in new structure of OCCT
    
    the path to search required headers changed from <occt>/inc to <occt>/src/<each package>
02Commenter 2
dear Author,

a fix has been integrated into CR26537 branch of OCCT git, please try to generate refman once again
03Commenter 3
dear apn,
could you apply the fix to the OCCT products
04Author
Reference documentation is generated correctly.
05Commenter 1
Branch [archived branch] has been updated by Commenter 2.

[revision removed]


Detailed log of new commits:

Author: Commenter 2
Date: Tue Aug 11 12:23:32 2015 +0300

    Fix for OCCT products reference documentation

06Commenter 2
Products reference documentation is generated from occt gendoc.bat. It's necessary to define variable PRODROOT in env.bat (if variable isn't defined documentation will be generated for occt).
Option -m contains list of modules (-m=ACIS,EMesh,SSP,SAT). If this option is missing, documentation will be generated for all modules.

Dear abv, could you please review.
07Commenter 7
Reviewed, please integrate.

One question, however: do we use the same script for generation of reference manual for products?
08Commenter 2
Yes, if PRODROOT isn't empty, documentation will be generated for products.
09Commenter 1
Branch [archived branch] has been deleted by Participant.

[revision removed]