diff options
| author | Daniel Elstner <daniel.kitta@gmail.com> | 2010-02-05 00:35:49 +0200 |
|---|---|---|
| committer | Daniel Elstner <daniel.kitta@gmail.com> | 2010-02-05 00:48:13 +0200 |
| commit | c74da3d67527c441342c24e5734f209b71f4fe84 (patch) | |
| tree | 344d59578b1d0d278c8b4566f5bcca99b74a23d7 | |
| parent | 23916076c083b1372e38cf18c8c1a063b981d6c2 (diff) | |
| download | mm-common-c74da3d67527c441342c24e5734f209b71f4fe84.tar.gz | |
Customize the skeleton documentation main page
* skeletonmm/skeleton/skeletonmm.h: Demonstrate the use of Doxygen's
@mainpage command to customize the generated documentation main page.
* skeletonmm/doc/Makefile.am (doc_input): Include the central header
in the list of input files for Doxygen.
* skeletonmm/doc/reference/Doxyfile.in (PREDEFINED): Extend the list
of predefined macros to hide a few more GLib annotations.
| -rw-r--r-- | skeletonmm/doc/Makefile.am | 5 | ||||
| -rw-r--r-- | skeletonmm/doc/reference/Doxyfile.in | 17 | ||||
| -rw-r--r-- | skeletonmm/skeleton/skeletonmm.h | 24 |
3 files changed, 39 insertions, 7 deletions
diff --git a/skeletonmm/doc/Makefile.am b/skeletonmm/doc/Makefile.am index b37409f..f271e13 100644 --- a/skeletonmm/doc/Makefile.am +++ b/skeletonmm/doc/Makefile.am @@ -1,4 +1,4 @@ -## Copyright (c) 2009 Joe Hacker <joe@example.com> +## Copyright (c) 2010 Joe Hacker <joe@example.com> ## ## This file is part of skeletonmm. ## @@ -21,6 +21,7 @@ include $(top_srcdir)/skeleton/skeletonmm/filelist.am skeletonmm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h)) book_name = $(SKELETONMM_MODULE_NAME) -doc_input = $(addprefix $(top_srcdir)/skeleton/skeletonmm/,$(skeletonmm_files_h)) +doc_input = $(top_srcdir)/skeleton/skeletonmm.h $(addprefix\ + $(top_srcdir)/skeleton/skeletonmm/,$(skeletonmm_files_h)) include $(top_srcdir)/build/doc-reference.am diff --git a/skeletonmm/doc/reference/Doxyfile.in b/skeletonmm/doc/reference/Doxyfile.in index ca003ed..1cf3306 100644 --- a/skeletonmm/doc/reference/Doxyfile.in +++ b/skeletonmm/doc/reference/Doxyfile.in @@ -234,12 +234,21 @@ INCLUDE_FILE_PATTERNS = *.h PREDEFINED = __cplusplus \ DOXYGEN_SHOULD_SKIP_THIS \ "G_GNUC_CONST=" \ + "G_GNUC_DEPRECATED=" \ + "G_GNUC_EXTENSION=" \ "G_GNUC_INTERNAL=" \ - "SKELETONMM_API=" \ - GLIBMM_VFUNCS_ENABLED \ - GLIBMM_PROPERTIES_ENABLED \ + "G_GNUC_MALLOC=" \ + "G_GNUC_NORETURN=" \ + "G_GNUC_NO_INSTRUMENT=" \ + "G_GNUC_NULL_TERMINATED=" \ + "G_GNUC_PURE=" \ + "G_GNUC_WARN_UNUSED_RESULT=" \ + "G_MODULE_EXPORT=" \ + GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED \ GLIBMM_EXCEPTIONS_ENABLED \ - GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED + GLIBMM_PROPERTIES_ENABLED \ + GLIBMM_VFUNCS_ENABLED \ + "SKELETONMM_API=" EXPAND_AS_DEFINED = SKELETONMM_MAJOR_VERSION \ SKELETONMM_MINOR_VERSION \ SKELETONMM_MICRO_VERSION diff --git a/skeletonmm/skeleton/skeletonmm.h b/skeletonmm/skeleton/skeletonmm.h index f6cbb91..30dfddd 100644 --- a/skeletonmm/skeleton/skeletonmm.h +++ b/skeletonmm/skeleton/skeletonmm.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2009 Joe Hacker <joe@example.com> +/* Copyright (c) 2010 Joe Hacker <joe@example.com> * * This file is part of skeletonmm. * @@ -19,7 +19,29 @@ #ifndef SKELETONMM_H_INCLUDED #define SKELETONMM_H_INCLUDED +/** @mainpage skeletonmm Reference Manual + * + * @section description Description + * + * The skeletonmm C++ binding provides a C++ interface on top of the skeleton + * C library. + * + * @section overview Overview + * + * [...] + * + * @section use Use + * + * To use skeletonmm in your C++ application, include the central header file + * <tt>\<skeletonmm.h\></tt>. The skeletonmm package ships a @c pkg-config + * file with the correct include path and link command-line for the compiler. + */ + #include <skeletonmmconfig.h> #include <skeletonmm/skeleton.h> +/** @example example/example.cc + * A skeletonmm example program. + */ + #endif /* !SKELETONMM_H_INCLUDED */ |