diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2021-04-30 17:56:17 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-30 17:56:17 (GMT) |
| commit | c9426698163a80a06fa30dba2357c7888f6eb11e (patch) | |
| tree | a3761ab543a1bb25b93c87e51e5376fa8ad8e4af /src | |
| parent | 44d55811919cca36ba0709d805fd5b1478fdf4ea (diff) | |
| parent | 21e1979a40202230a9df783470484aa6ee1199da (diff) | |
| download | Doxygen-c9426698163a80a06fa30dba2357c7888f6eb11e.zip Doxygen-c9426698163a80a06fa30dba2357c7888f6eb11e.tar.gz Doxygen-c9426698163a80a06fa30dba2357c7888f6eb11e.tar.bz2 | |
Merge pull request #8501 from albert-github/feature/bug_docu_improv
Some documentation improvements
Diffstat (limited to 'src')
| -rw-r--r-- | src/config.xml | 3 | ||||
| -rwxr-xr-x | src/configgen.py | 3 |
2 files changed, 5 insertions, 1 deletions
diff --git a/src/config.xml b/src/config.xml index f3f4e5c..be890c3 100644 --- a/src/config.xml +++ b/src/config.xml @@ -1249,6 +1249,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn" doxygen's defaults, run doxygen with the `-l` option. You can optionally specify a file name after the option, if omitted \c DoxygenLayout.xml will be used as the name of the layout file. + See also section \ref layout for information. <br>Note that if you run doxygen from a directory containing a file called \c DoxygenLayout.xml, doxygen will parse it automatically even if the \c LAYOUT_FILE tag is left empty. @@ -2379,7 +2380,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. Windows users are probably better off using the HTML help feature. Via custom style sheets (see \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET") - one can further \ref doxygen_finetune "fine-tune" the look of the index. + one can further fine tune the look of the index (see \ref doxygen_finetune). As an example, the default style sheet generated by doxygen has an example that shows how to put an image at the root of the tree instead of the \ref cfg_project_name "PROJECT_NAME". diff --git a/src/configgen.py b/src/configgen.py index d3b9137..5c4c39a 100755 --- a/src/configgen.py +++ b/src/configgen.py @@ -56,8 +56,11 @@ def transformDocs(doc): doc = re.sub('\\\\ref +doxygen_usage', '"Doxygen usage"', doc) doc = re.sub('\\\\ref +extsearch', '"External Indexing and Searching"', doc) + doc = re.sub('\\\\ref +layout', '"Changing the layout of pages"', doc) doc = re.sub('\\\\ref +external', '"Linking to external documentation"', doc) + doc = re.sub('\\\\ref +doxygen_finetune', '"Fine-tuning the output"', + doc) doc = re.sub('\\\\ref +formulas', '"Including formulas"', doc) # fallback for not handled doc = re.sub('\\\\ref', '', doc) |