Skip to content

Commit 04d271d

Browse files
committed
Add module part to customize documentation
- adding missing module part - small corrections about available items - small layout issues
1 parent 61fa3f8 commit 04d271d

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

doc/customize.dox

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,8 @@ pages generated by Doxygen:
301301
documented namespaces (and also Java packages).
302302
- The \c concept element represents the layout of all pages generated for
303303
documented concepts.
304+
- The \c module element represents the layout of all pages generated for
305+
documented C++ modules.
304306
- The \c file element represents the layout of all pages generated for
305307
documented files.
306308
- The \c group element represents the layout of all pages generated for
@@ -320,6 +322,9 @@ The following generic elements are possible for each page:
320322
<dd>Represents the brief description on a page.
321323
<dt>\c detaileddescription
322324
<dd>Represents the detailed description on a page.
325+
</dl>
326+
The following generic element is possible for each page except the \c directory page:
327+
<dl>
323328
<dt>\c authorsection
324329
<dd>Represents the author section of a page (only used for man pages). This is
325330
a separate section for man pages with a text like:
@@ -328,21 +333,24 @@ The following generic elements are possible for each page:
328333
"\\author" or \ref cmdauthors "\\authors" that generate an author paragraph
329334
inside a detailed description.
330335
</dl>
331-
The following generic elements are possible for each page except the concept page:
336+
The following generic element is possible for each page except the \c concept page:
332337
<dl>
333338
<dt>\c memberdecl
334339
<dd>Represents the quick overview of members on a page (member declarations).
335340
This elements has child elements per type of member list.
336341
The possible child elements are not listed in detail in the document,
337342
but the name of the element should be a good indication of the type
338343
of members that the element represents.
344+
</dl>
345+
The following generic element is possible for each page except the \c concept and \c module page:
346+
<dl>
339347
<dt>\c memberdef
340348
<dd>Represents the detailed member list on a page (member definition).
341349
Like the \c memberdecl element, also this element has a number of
342350
possible child elements.
343351
</dl>
344352

345-
The class page has the following specific elements:
353+
The \c class page has the following specific elements:
346354
<dl>
347355
<dt>\c includes
348356
<dd>Represents the include file needed to obtain the definition for
@@ -361,7 +369,7 @@ The class page has the following specific elements:
361369
extracted.
362370
</dl>
363371

364-
The concept page has the following specific elements:
372+
The \c concept page has the following specific elements:
365373
<dl>
366374
<dt>\c includes
367375
<dd>Represents the include file needed to obtain the definition for
@@ -370,7 +378,7 @@ The concept page has the following specific elements:
370378
<dd>Represents the definition of the concept
371379
</dl>
372380

373-
The file page has the following specific elements:
381+
The \c file page has the following specific elements:
374382
<dl>
375383
<dt>\c includes
376384
<dd>Represents the list of \#include statements contained in this file.
@@ -382,16 +390,19 @@ The file page has the following specific elements:
382390
<dd>Represents the link to the source code of this file.
383391
</dl>
384392

385-
The group page has a specific \c groupgraph element which represents the
393+
The \c module page has a specific \c exportedmodules element which represents the
394+
modules that are exported from this module.
395+
396+
The \c group page has a specific \c groupgraph element which represents the
386397
graph showing the dependencies between groups.
387398

388-
Similarly, the directory page has a specific \c directorygraph element
399+
Similarly, the \c directory page has a specific \c directorygraph element
389400
which represents the graph showing the dependencies between the directories
390401
based on the \#include relations of the files inside the directories.
391402

392403
Some elements have a \c visible attribute which can be
393404
used to hide the fragment from the generated output, by setting the attribute's
394-
value to "no". You can also use the value of a configuration option to
405+
value to \c no. You can also use the value of a configuration option to
395406
determine the visibility, by using
396407
its name prefixed with a dollar sign, e.g.
397408
\verbatim

0 commit comments

Comments
 (0)