diff --git a/Doxyfile b/Doxyfile index a55cc86..44d31d5 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,7 +1,9 @@ # -*- mode: conf-unix -*- PROJECT_NAME = "remwharead" PROJECT_NUMBER = 0.0.0 -INPUT = src/lib/ src/lib/export/ include/ +INPUT = src/lib/ include/ +RECURSIVE = YES +STRIP_FROM_INC_PATH = "include" # EXAMPLE_PATH = examples/ EXAMPLE_RECURSIVE = YES GENERATE_HTML = YES diff --git a/include/export/adoc.hpp b/include/export/adoc.hpp index ad1c7ab..8e0a0bd 100644 --- a/include/export/adoc.hpp +++ b/include/export/adoc.hpp @@ -29,7 +29,13 @@ namespace Export { using std::string; - //! Export as %AsciiDoc document. + /*! + * @brief Export as %AsciiDoc document. + * + * @since 0.6.0 + * + * @headerfile adoc.hpp remwharead/export/adoc.hpp + */ class AsciiDoc : protected ExportBase { public: diff --git a/include/export/bookmarks.hpp b/include/export/bookmarks.hpp index 94e7963..2961e22 100644 --- a/include/export/bookmarks.hpp +++ b/include/export/bookmarks.hpp @@ -23,7 +23,13 @@ namespace remwharead { namespace Export { - //! Export as Netscape bookmark file. + /*! + * @brief Export as Netscape bookmark file. + * + * @since 0.6.0 + * + * @headerfile bookmarks.hpp remwharead/export/bookmarks.hpp + */ class Bookmarks : protected ExportBase { public: diff --git a/include/export/csv.hpp b/include/export/csv.hpp index a27a614..f4090d5 100644 --- a/include/export/csv.hpp +++ b/include/export/csv.hpp @@ -26,7 +26,13 @@ namespace Export { using std::string; - //! Export as Comma Separated Values. + /*! + * @brief Export as Comma Separated Values. + * + * @since 0.6.0 + * + * @headerfile csv.hpp remwharead/export/csv.hpp + */ class CSV : protected ExportBase { public: diff --git a/include/export/export.hpp b/include/export/export.hpp index fb6d00c..bf0634f 100644 --- a/include/export/export.hpp +++ b/include/export/export.hpp @@ -29,7 +29,13 @@ namespace remwharead { namespace Export { - //! Base class for exports. + /*! + * @brief Base class for exports. + * + * @since 0.6.0 + * + * @headerfile export.hpp remwharead/export/export.hpp + */ class ExportBase { public: diff --git a/include/export/simple.hpp b/include/export/simple.hpp index 39bd625..939683c 100644 --- a/include/export/simple.hpp +++ b/include/export/simple.hpp @@ -23,7 +23,13 @@ namespace remwharead { namespace Export { - //! Export as simple list. + /*! + * @brief Export as simple list. + * + * @since 0.6.0 + * + * @headerfile simple.hpp remwharead/export/simple.hpp + */ class Simple : protected ExportBase { public: diff --git a/include/sqlite.hpp b/include/sqlite.hpp index f30b9cd..1826d81 100644 --- a/include/sqlite.hpp +++ b/include/sqlite.hpp @@ -32,11 +32,23 @@ namespace remwharead using std::chrono::system_clock; using time_point = system_clock::time_point; - //! Store and retrieve files from/to SQLite. + /*! + * @brief Store and retrieve files from/to SQLite. + * + * @since 0.6.0 + * + * @headerfile sqlite.hpp remwharead/sqlite.hpp + */ class Database { public: - //! Describes a database entry. + /*! + * @brief Describes a database entry. + * + * @since 0.6.0 + * + * @headerfile sqlite.hpp remwharead/sqlite.hpp + */ typedef struct entry { string uri; diff --git a/include/time.hpp b/include/time.hpp index 0df526e..4e52d96 100644 --- a/include/time.hpp +++ b/include/time.hpp @@ -40,7 +40,7 @@ namespace remwharead bool sqlite = false); /*! - * @brief Convert time_point to ISO 8601 or SQLite time-string. + * @brief Convert time_point to ISO 8601 or SQLite time-string. * * The SQLite format is *YY-MM-DD hh:mm:ss* instead of *YY-MM-DDThh:mm:ss*. * diff --git a/include/types.hpp b/include/types.hpp index 41c1563..6e08daf 100644 --- a/include/types.hpp +++ b/include/types.hpp @@ -21,7 +21,13 @@ namespace remwharead { - //! Format of the export. + /*! + * @brief Format of the export. + * + * @since 0.6.0 + * + * @headerfile types.hpp remwharead/types.hpp + */ enum class export_format { undefined, diff --git a/include/uri.hpp b/include/uri.hpp index 1521915..61e9cb2 100644 --- a/include/uri.hpp +++ b/include/uri.hpp @@ -23,7 +23,13 @@ namespace remwharead { using std::string; - //! A processed HTML page. + /*! + * @brief A processed HTML page. + * + * @since 0.6.0 + * + * @headerfile uri.hpp remwharead/uri.hpp + */ typedef struct html_extract { string title; @@ -31,7 +37,13 @@ namespace remwharead string fulltext; } html_extract; - //! Download, archive and process an %URI. + /*! + * @brief Download, archive and process an %URI. + * + * @since 0.6.0 + * + * @headerfile uri.hpp remwharead/uri.hpp + */ class URI { public: