Display right include paths in Doxygen output.
continuous-integration/drone/push Build is passing Details

This commit is contained in:
tastytea 2019-08-05 23:19:44 +02:00
parent a40a394b1a
commit df59f484c6
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
10 changed files with 74 additions and 12 deletions

View File

@ -1,7 +1,9 @@
# -*- mode: conf-unix -*- # -*- mode: conf-unix -*-
PROJECT_NAME = "remwharead" PROJECT_NAME = "remwharead"
PROJECT_NUMBER = 0.0.0 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_PATH = examples/
EXAMPLE_RECURSIVE = YES EXAMPLE_RECURSIVE = YES
GENERATE_HTML = YES GENERATE_HTML = YES

View File

@ -29,7 +29,13 @@ namespace Export
{ {
using std::string; 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 class AsciiDoc : protected ExportBase
{ {
public: public:

View File

@ -23,7 +23,13 @@ namespace remwharead
{ {
namespace Export 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 class Bookmarks : protected ExportBase
{ {
public: public:

View File

@ -26,7 +26,13 @@ namespace Export
{ {
using std::string; 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 class CSV : protected ExportBase
{ {
public: public:

View File

@ -29,7 +29,13 @@ namespace remwharead
{ {
namespace Export namespace Export
{ {
//! Base class for exports. /*!
* @brief Base class for exports.
*
* @since 0.6.0
*
* @headerfile export.hpp remwharead/export/export.hpp
*/
class ExportBase class ExportBase
{ {
public: public:

View File

@ -23,7 +23,13 @@ namespace remwharead
{ {
namespace Export 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 class Simple : protected ExportBase
{ {
public: public:

View File

@ -32,11 +32,23 @@ namespace remwharead
using std::chrono::system_clock; using std::chrono::system_clock;
using time_point = system_clock::time_point; 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 class Database
{ {
public: public:
//! Describes a database entry. /*!
* @brief Describes a database entry.
*
* @since 0.6.0
*
* @headerfile sqlite.hpp remwharead/sqlite.hpp
*/
typedef struct entry typedef struct entry
{ {
string uri; string uri;

View File

@ -40,7 +40,7 @@ namespace remwharead
bool sqlite = false); 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*. * The SQLite format is *YY-MM-DD hh:mm:ss* instead of *YY-MM-DDThh:mm:ss*.
* *

View File

@ -21,7 +21,13 @@
namespace remwharead 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 enum class export_format
{ {
undefined, undefined,

View File

@ -23,7 +23,13 @@ namespace remwharead
{ {
using std::string; 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 typedef struct html_extract
{ {
string title; string title;
@ -31,7 +37,13 @@ namespace remwharead
string fulltext; string fulltext;
} html_extract; } 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 class URI
{ {
public: public: