summaryrefslogtreecommitdiffstats
path: root/doc/customize.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-06-10 11:03:23 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-06-10 11:03:23 (GMT)
commit39232901e3577f6e548353b89c4338cc8ba11016 (patch)
treec1c0202bd83410a383043559051492a114a005ee /doc/customize.doc
parent4536982bdebc0056d0c5d64a12881f20b5801c06 (diff)
downloadDoxygen-39232901e3577f6e548353b89c4338cc8ba11016.zip
Doxygen-39232901e3577f6e548353b89c4338cc8ba11016.tar.gz
Doxygen-39232901e3577f6e548353b89c4338cc8ba11016.tar.bz2
Bug 754440 - Can't suppress @author, @date and @copyright information in the detailed file description
Small clarification regarding `authorsection` versus `\author`
Diffstat (limited to 'doc/customize.doc')
-rw-r--r--doc/customize.doc7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/customize.doc b/doc/customize.doc
index e2d53db..79f1e1a 100644
--- a/doc/customize.doc
+++ b/doc/customize.doc
@@ -289,7 +289,12 @@ The following generic elements are possible for each page:
<dt>\c detaileddescription
<dd>Represents the detailed description on a page.
<dt>\c authorsection
- <dd>Represents the author section of a page (only used for man pages).
+ <dd>Represents the author section of a page (only used for man pages). This is
+ a separate section for man pages with a text like:
+ `Generated automatically by Doxygen for My Project from the source code.`
+ This should not be misinterpreted with the doxygen commands \ref cmdauthor
+ "\\author" or \ref cmdauthors "\\authors" that generate an author paragraph
+ inside a detailed description.
<dt>\c memberdecl
<dd>Represents the quick overview of members on a page (member declarations).
This elements has child elements per type of member list.