Mailinglist Archive: zypp-devel (53 mails)

< Previous Next >
[zypp-devel] Some changes related to libzypp autodocs (doxygen)
  • From: Michael Andres <ma@xxxxxxx>
  • Date: Thu, 2 Oct 2008 18:04:35 +0200
  • Message-id: <200810021804.35936.ma@xxxxxxx>
Hi!

@Revision: 11232

I removed the mostly unsudes doxygen files from the source tree
(/libzypp/zypp/@DOXYGEN) and created a new place where to create
documentation pages that should be included in the autodocs:

/libzypp/doc/autoinclude/

You'll find a README and some examples there.


Basically, to write a related page, create a file and include a doxygen
comment block like this:

--[MyTopic.doc]-----
/** \page MyTopic A documentation for MyTopic.

Leading text.

\section sec1 An example section
This page contains the subsections \ref subsection1 and \ref
subsection2. For more info see page \ref page2.

\subsection subsection1 The first subsection
Text.

\subsection subsection2 The second subsection
More text.
*/

/** \page page2 Another page
Even more info.
*/
------------------------------
(..I know - it's doxygen ;)


If you want your page to appear somewhere else than in 'Related Pages', use
\subpage to create the link. E.g. from within the main page (Mainpage.doc):

--[Mainpage.doc]-----
/** \mainpage Welcome to libzypp

More info about this:
- \subpage MyTopic

*/
------------------------------


Just in case someone really writes a bigger set of pages, and wants to run
doxygen without scanning the sourcetree: In doc/autodoc/Doxyfile.cmake
change

-INPUT = @ZYPP_DOCINCLUDE_DIR@ @ZYPP_SOURCE_DIR@
+INPUT = @ZYPP_DOCINCLUDE_DIR@

and use 'make doc_forced' to force rebuilding the autodocs.

--

cu,
Michael Andres

+------------------------------------------------------------------+
Key fingerprint = 2DFA 5D73 18B1 E7EF A862 27AC 3FB8 9E3A 27C6 B0E4
+------------------------------------------------------------------+
Michael Andres YaST Development ma@xxxxxxxxxx
SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nuernberg)
Maxfeldstrasse 5, D-90409 Nuernberg, Germany, ++49 (0)911 - 740 53-0
+------------------------------------------------------------------+

--
To unsubscribe, e-mail: zypp-devel+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: zypp-devel+help@xxxxxxxxxxxx

< Previous Next >
This Thread
  • No further messages