aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-08-12 10:36:36 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-08-12 10:36:36 +0000
commit6f05bd05b26f3951b351fd2f11c5ae6b27ad78fb (patch)
treec276abed3173ed7e339b8129f683b7822787b9e8
parentc82ebe4ed09dc2cc5bfbf110215b67e13a9cc8d4 (diff)
downloadpaludis-6f05bd05b26f3951b351fd2f11c5ae6b27ad78fb.tar.gz
paludis-6f05bd05b26f3951b351fd2f11c5ae6b27ad78fb.tar.xz
Docs tweaks
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/doc_directories.doxygen18
-rw-r--r--doc/doxygen.conf.in4
-rwxr-xr-xmisc/make_sr.bash64
-rw-r--r--paludis/digests/md5_TEST.cc20
-rw-r--r--paludis/digests/rmd160_TEST.cc20
-rw-r--r--paludis/digests/sha256_TEST.cc26
-rw-r--r--paludis/repositories/nothing/nothing_repository.sr9
8 files changed, 131 insertions, 31 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a5a8b1e..40cca23 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -6,7 +6,6 @@ docfiles = \
doc_mainpage.doxygen \
doc_coding_standards.doxygen \
doc_namespaces.doxygen \
- doc_directories.doxygen \
doc_references.doxygen \
doc_licence.doxygen \
doc_authors.doxygen \
diff --git a/doc/doc_directories.doxygen b/doc/doc_directories.doxygen
deleted file mode 100644
index 6db86ff..0000000
--- a/doc/doc_directories.doxygen
+++ /dev/null
@@ -1,18 +0,0 @@
-/* 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/doxygen.conf.in b/doc/doxygen.conf.in
index ca631c8..609b3e3 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 ../paludis/util ../paludis/digests ../paludis/selinux ../paludis/repositories ../paludis/repositories/nothing ../paludis/repositories/portage ../paludis/repositories/vdb ../paludis/repositories/fake ../test ../doc ../src
+INPUT = ../paludis ../paludis/args ../paludis/util ../paludis/digests ../paludis/selinux ../paludis/repositories ../paludis/repositories/nothing ../paludis/repositories/portage ../paludis/repositories/vdb ../paludis/repositories/fake ../test ../doc ../src ../src/paludis ../src/qualudis
# 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
@@ -461,7 +461,7 @@ INPUT = ../paludis ../paludis/args ../paludis/util ../paludis/digests ../paludis
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
-FILE_PATTERNS = *.hh *.cc *.doxygen
+FILE_PATTERNS = *.hh *.doxygen
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
diff --git a/misc/make_sr.bash b/misc/make_sr.bash
index be10a4f..e932f00 100755
--- a/misc/make_sr.bash
+++ b/misc/make_sr.bash
@@ -57,6 +57,11 @@ while read a ; do
want_named_args=yes
}
+ doxygen_comment()
+ {
+ :
+ }
+
key()
{
want_keys=( "${want_keys[@]}" "$1" )
@@ -76,15 +81,8 @@ while read a ; do
want_comparison_fields=( ${want_keys[@]} )
fi
- extra_constructors()
- {
- echo
- cat
- }
-
- extra_methods()
+ doxygen_comment()
{
- echo
cat
}
@@ -103,6 +101,27 @@ while read a ; do
:
}
+
+ make_class_${a}
+
+ doxygen_comment()
+ {
+ :
+ }
+
+
+ extra_constructors()
+ {
+ echo
+ cat
+ }
+
+ extra_methods()
+ {
+ echo
+ cat
+ }
+
if [[ "${what_to_make}" == "--header" ]] ; then
echo "class ${a}"
echo "{"
@@ -181,25 +200,38 @@ while read a ; do
for (( k = 0 ; k < ${#want_keys[@]} ; k++ )) ; do
n=${want_keys[${k}]}
t=${want_key_types[${k}]}
+ echo " /**"
+ echo " * Holds the named parameter construction value for ${a}.${n}"
+ echo " */"
echo " class Param_${n}"
echo " {"
echo " private:"
echo " Param_${n}();"
echo
echo " public:"
+ echo " /// The value"
echo " $(make_const_ref "${t}" ) ${n};"
echo
+ echo " ///\\name Basic operations"
+ echo " ///\\{"
+ echo
echo " Param_${n}(const Empty &, $(make_const_ref "${t}" ) value_for_${n}) :"
echo " ${n}(value_for_${n})"
echo " {"
echo " }"
echo
+ echo " /// Constructor"
echo " Param_${n}(const Empty &, const Param_${n} & other) :"
echo " ${n}(other.${n})"
echo " {"
echo " }"
+ echo
+ echo " ///\\}"
echo " };"
echo
+ echo " /**"
+ echo " * Provides the ${n} method for ${a} named parameters."
+ echo " */"
echo " template <typename Before_, typename After_>"
echo " class ParamNeeded_${n}"
echo " {"
@@ -207,6 +239,9 @@ while read a ; do
echo " const Before_ & _before;"
echo
echo " public:"
+ echo " ///\\name Basic operations"
+ echo " ///\\{"
+ echo
echo " After_"
echo " ${n}($(make_const_ref "${t}" ) value_for_${n})"
echo " {"
@@ -230,10 +265,15 @@ while read a ; do
echo " _before(before)"
echo " {"
echo " }"
+ echo
+ echo " ///\\}"
echo " };"
echo
done
+ echo " /**"
+ echo " * Handle named parameters for ${a}."
+ echo " */"
echo " template <"
for (( k = 0 ; k < ${#want_keys[@]} ; k++ )) ; do
echo -n " bool has_${want_keys[${k}]}_"
@@ -283,6 +323,9 @@ while read a ; do
echo " Params();"
echo
echo " public:"
+ echo " ///\\name Basic operations"
+ echo " ///\\{"
+ echo
echo " Params("
for (( k = 0 ; k < ${#want_keys[@]} ; k++ )) ; do
n=${want_keys[${k}]}
@@ -347,9 +390,12 @@ while read a ; do
echo " );"
echo " }"
echo
+ echo " ///\\}"
+ echo
echo " };"
echo
+ echo " /// Create, via named parameters"
echo -n " static Params<"
for (( k = 0 ; k < ${#want_keys[@]} ; k++ )) ; do
echo -n "false"
@@ -358,8 +404,6 @@ while read a ; do
fi
done
echo "> create();"
-
- echo " ///\\}"
echo
fi
diff --git a/paludis/digests/md5_TEST.cc b/paludis/digests/md5_TEST.cc
index 2b97a3f..3382eab 100644
--- a/paludis/digests/md5_TEST.cc
+++ b/paludis/digests/md5_TEST.cc
@@ -26,6 +26,12 @@ using namespace test;
namespace
{
+ /**
+ * \name Test utilities
+ * \ingroup grptestcases
+ * \{
+ */
+
unsigned char dehex_c(unsigned char c)
{
if (c >= '0' && c <= '9')
@@ -49,10 +55,20 @@ namespace
}
return result;
}
+
+ /**
+ * \}
+ */
}
namespace test_cases
{
+ /**
+ * \name Test cases for paludis::digests::MD5
+ * \ingroup grptestcases
+ * \{
+ */
+
struct MD5TestCase : TestCase
{
std::string data;
@@ -89,6 +105,10 @@ namespace test_cases
MD5TestCase t_8("one million times a",
std::string(1000000, 'a'),
"7707d6ae4e027c70eea2a935c2296f21");
+
+ /**
+ * \}
+ */
}
diff --git a/paludis/digests/rmd160_TEST.cc b/paludis/digests/rmd160_TEST.cc
index 0a1d13b..8182dae 100644
--- a/paludis/digests/rmd160_TEST.cc
+++ b/paludis/digests/rmd160_TEST.cc
@@ -26,6 +26,12 @@ using namespace paludis;
namespace
{
+ /**
+ * \name Test utilities
+ * \ingroup grptestcases
+ * \{
+ */
+
unsigned char dehex_c(unsigned char c)
{
if (c >= '0' && c <= '9')
@@ -49,10 +55,20 @@ namespace
}
return result;
}
+
+ /**
+ * \}
+ */
}
namespace test_cases
{
+ /**
+ * \name Test cases for paludis::digests::RMD160
+ * \ingroup grptestcases
+ * \{
+ */
+
struct RMD160TestCase : TestCase
{
std::string data;
@@ -92,5 +108,9 @@ namespace test_cases
RMD160TestCase t_8("one million times a",
std::string(1000000, 'a'),
"52783243c1697bdbe16d37f97f68f08325dc1528");
+
+ /**
+ * \}
+ */
}
diff --git a/paludis/digests/sha256_TEST.cc b/paludis/digests/sha256_TEST.cc
index d7f2cab..6b6c3cb 100644
--- a/paludis/digests/sha256_TEST.cc
+++ b/paludis/digests/sha256_TEST.cc
@@ -24,8 +24,20 @@
using namespace test;
using namespace paludis;
+/** \file
+ * Test cases for paludis::digests::SHA256.
+ *
+ * \ingroup grptestcases
+ */
+
namespace
{
+ /**
+ * \name Test utilities
+ * \ingroup grptestcases
+ * \{
+ */
+
unsigned char dehex_c(unsigned char c)
{
if (c >= '0' && c <= '9')
@@ -49,10 +61,20 @@ namespace
}
return result;
}
+
+ /**
+ * \}
+ */
}
namespace test_cases
{
+ /**
+ * \name Test cases for paludis::digests::SHA256
+ * \ingroup grptestcases
+ * \{
+ */
+
struct SHA256TestCase : TestCase
{
std::string data;
@@ -416,5 +438,9 @@ namespace test_cases
"c5452bbbf09317b50c5c9fb1997553d2bbc29bb4"
"2f5748ad"), "105a60865830ac3a371d3843324d4bb5fa8ec0e0"
"2ddaa389ad8da4f10215c454");
+
+ /**
+ * \}
+ */
}
diff --git a/paludis/repositories/nothing/nothing_repository.sr b/paludis/repositories/nothing/nothing_repository.sr
index 71bf2d1..fab9d3e 100644
--- a/paludis/repositories/nothing/nothing_repository.sr
+++ b/paludis/repositories/nothing/nothing_repository.sr
@@ -9,6 +9,15 @@ make_class_NothingRepositoryParams()
key sync_exclude std::string
allow_named_args
+
+ doxygen_comment << "END"
+ /**
+ * Parameters for a NothingRepository.
+ *
+ * \see NothingRepository
+ * \ingroup grpnothingrepository
+ */
+END
}