DiscussionsIssue archiveOCCT:Documentation

Archived issue #0026992

Use Doxygen tag @ref for cross-references in documentation

Open CASCADEOCCT:Documentationclosed6 public notes

Search issues

Description

Currently in many places in OCCT documentation (user and dev guides, overview, etc.) HTML-style references (#...tag...) are used to refer to other sections of the documentation. This works, to some extent, in HTML, but generates non-working links in PDF. Instead, Doxygen tag @ref should be used for cross-references in documentation, like this:

@ref occt_coding_rules_3 "Formatting Rules"

instead of

#occt_coding_rules_3

Steps to reproduce

NA

Public activity

6 archived notes

Participants are labeled by their role within this record.

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

[revision removed]


Detailed log of new commits:

Author: ysn
Date: Fri Dec 18 15:33:23 2015 +0300

    href have been replaced by @ref tags except for the links to web-pages and other documents where @ref tags do not work either.
02Commenter 2
The patch files are already based on 26964 and 26212. Should not pose any merging problems.
03Commenter 3
Tags replaced.
04Commenter 2
Branch [archived branch] has been updated forcibly by Author.

[revision removed]
05Commenter 5
Reviewed and rebased on CR26964
06Commenter 2
Branch [archived branch] has been deleted by Participant.

[revision removed]