aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-24 01:23:53 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-24 01:23:53 +0000
commitbfa471b69fb1d06eed7137590c60965094cd19c1 (patch)
treec77988aff18ac84251e421870d277530999eef9f
parente2e9605fd206680d6dbe54af0057db5e89e1e5e0 (diff)
downloadpaludis-bfa471b69fb1d06eed7137590c60965094cd19c1.tar.gz
paludis-bfa471b69fb1d06eed7137590c60965094cd19c1.tar.xz
Doxygen updates
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/doc_directories.doxygen18
-rw-r--r--doc/doc_main.doxygen26
-rw-r--r--doc/doc_namespaces.doxygen24
-rw-r--r--doc/doxygen.conf.in2
5 files changed, 46 insertions, 28 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 4594458..a89798e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,7 +4,9 @@ MAINTAINERCLEANFILES = Makefile.in
docfiles = \
doc_main.doxygen \
doc_mainpage.doxygen \
- doc_coding_standards.doxygen
+ doc_coding_standards.doxygen \
+ doc_namespaces.doxygen \
+ doc_directories.doxygen
EXTRA_DIST = doxygen.conf.in $(docfiles)
diff --git a/doc/doc_directories.doxygen b/doc/doc_directories.doxygen
new file mode 100644
index 0000000..6db86ff
--- /dev/null
+++ b/doc/doc_directories.doxygen
@@ -0,0 +1,18 @@
+/* vim: set ft=cpp tw=80 sw=4 et : */
+
+/** \dir paludis
+ * Paludis library code.
+ */
+
+/** \dir src
+ * Paludis program source.
+ */
+
+/** \dir paludis/args
+ * Paludis commandline argument handling utilities.
+ */
+
+/** \dir test
+ * Test framework.
+ */
+
diff --git a/doc/doc_main.doxygen b/doc/doc_main.doxygen
index 04940e4..c39267a 100644
--- a/doc/doc_main.doxygen
+++ b/doc/doc_main.doxygen
@@ -1,31 +1,5 @@
/* vim: set ft=cpp tw=80 sw=4 et : */
-/** \namespace test_cases
- * Test cases.
- *
- * \ingroup Test
- */
-
-/** \namespace test
- * Test framework.
- *
- * \ingroup Test
- */
-
-/** \namespace paludis::args
- * Commandline argument handling.
- *
- * \ingroup Args
- */
-
-/** \namespace paludis
- * Paludis library code.
- */
-
-/** \dir paludis
- * Paludis library code.
- */
-
/** \defgroup DepResolver Dependency parsing and resolution
* Dependency parsing and resolution.
*
diff --git a/doc/doc_namespaces.doxygen b/doc/doc_namespaces.doxygen
new file mode 100644
index 0000000..66385b6
--- /dev/null
+++ b/doc/doc_namespaces.doxygen
@@ -0,0 +1,24 @@
+/* vim: set ft=cpp tw=80 sw=4 et : */
+
+/** \namespace test_cases
+ * Test cases.
+ *
+ * \ingroup Test
+ */
+
+/** \namespace test
+ * Test framework.
+ *
+ * \ingroup Test
+ */
+
+/** \namespace paludis::args
+ * Commandline argument handling.
+ *
+ * \ingroup Args
+ */
+
+/** \namespace paludis
+ * Paludis library code.
+ */
+
diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in
index c7159cf..2e2e319 100644
--- a/doc/doxygen.conf.in
+++ b/doc/doxygen.conf.in
@@ -452,7 +452,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ../paludis ../paludis/args ../test ../doc
+INPUT = ../paludis ../paludis/args ../test ../doc ../src
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp