← Back to branch summary

~thopiekar/zypper/libzypp-manual-import

« back to all changes in this revision

Viewing changes to doc/autoinclude/README

  • Committer: Thomas-Karl Pietrowski
  • Date: 2014-01-29 22:44:28 UTC
  • Revision ID: thopiekar@googlemail.com-20140129224428-gpcqnsdakby362n8
first import

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/autoinclude/README
 
1
All .doc files here will be parsed and included in the autodocs generated
 
2
by doxygen (see http://www.doxygen.org/). All the other files here (mostly
 
3
below notes) are available to be vervatim included in some documentation
 
4
block using:
 
5
 
 
6
    /** \include somefile
 
7
    */
 
8
  or
 
9
    /** \example
 
10
    */
 
11
 
 
12
 
 
13
The .doc files here will mostly provide:
 
14
 
 
15
- The content of the main index page (defined in Mainpage.doc).
 
16
 
 
17
- Other related documentation pages:
 
18
 
 
19
  /*! \page page1 A documentation page
 
20
    Leading text.
 
21
    \section sec An example section
 
22
    This page contains the subsections \ref subsection1 and \ref subsection2.
 
23
    For more info see page \ref page2.
 
24
    \subsection subsection1 The first subsection
 
25
    Text.
 
26
    \subsection subsection2 The second subsection
 
27
    More text.
 
28
  */
 
29
 
 
30
  /*! \page page2 Another page
 
31
    Even more info.
 
32
  */
 
33
 
 
34
Those pages will per default appear in the documentations 'Related Pages'
 
35
section, unless you refer to them from within soome other page by using
 
36
'\subpage':
 
37
 
 
38
  /** \mainpage A simple manual
 
39
 
 
40
  Some general info.
 
41
 
 
42
  This manual is divided in the following sections:
 
43
  - \subpage intro
 
44
  - \subpage advanced "Advanced usage"
 
45
  */
 
46
 
 
47
 
 
48
- Documentation for a group of classes defined by \ingroup:
 
49
 
 
50
  /*! \defgroup g_Resolvable Resolvable Objects
 
51
    Some explanation.
 
52
  */
 
53
 
 
54
- And whatever else we don't want to keep in the header files.