Skip to content

Commit

Permalink
Concept mising in the layout description
Browse files Browse the repository at this point in the history
Added missing concept description
  • Loading branch information
albert-github committed Apr 24, 2022
1 parent 3d900c6 commit 3931e45
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions doc/customize.doc
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,9 @@ The toplevel structure of the file looks as follows:
<namespace>
...
</namespace>
<concept>
...
</concept>
<file>
...
</file>
Expand Down Expand Up @@ -291,6 +294,8 @@ pages generated by doxygen:
documented classes, structs, unions, and interfaces.
- The \c namespace element represents the layout of all pages generated for
documented namespaces (and also Java packages).
- The \c concept element represents the layout of all pages generated for
documented concepts.
- The \c file element represents the layout of all pages generated for
documented files.
- The \c group element represents the layout of all pages generated for
Expand All @@ -317,6 +322,9 @@ The following generic elements are possible for each page:
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.
</dl>
The following generic elements are possible for each page except the concept page:
<dl>
<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.
Expand Down Expand Up @@ -348,6 +356,15 @@ The class page has the following specific elements:
extracted.
</dl>

The concept page has the following specific elements:
<dl>
<dt>\c includes
<dd>Represents the include file needed to obtain the definition for
this class.
<dt>\c definition
<dd>Represents the definition of the concept
</dl>

The file page has the following specific elements:
<dl>
<dt>\c includes
Expand Down

0 comments on commit 3931e45

Please sign in to comment.