From fcab1971630c43b57cecc775d9c3078563fc86ff Mon Sep 17 00:00:00 2001
From: Olivier Stasse <ostasse@laas.fr>
Date: Thu, 21 May 2020 19:06:34 +0200
Subject: [PATCH] [doc] Fix documentation (wrong image references + error on
doxygen.log)
---
doc/Doxyfile.extra.in | 6 ++----
doc/additionalDoc/debug-logger.h | 2 +-
doc/additionalDoc/introduction.h | 2 +-
doc/{figures => pictures}/Concept-Software-Fig.png | Bin
doc/{figures => pictures}/entity.png | Bin
doc/{figures => pictures}/entity.svg | 0
doc/{figures => pictures}/use-case.png | Bin
include/dynamic-graph/logger.h | 5 +++--
include/dynamic-graph/real-time-logger-def.h | 2 +-
9 files changed, 8 insertions(+), 9 deletions(-)
rename doc/{figures => pictures}/Concept-Software-Fig.png (100%)
rename doc/{figures => pictures}/entity.png (100%)
rename doc/{figures => pictures}/entity.svg (100%)
rename doc/{figures => pictures}/use-case.png (100%)
diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in
index 22d7f26..bd125c6 100644
--- a/doc/Doxyfile.extra.in
+++ b/doc/Doxyfile.extra.in
@@ -293,8 +293,6 @@ WARN_LOGFILE = @CMAKE_BINARY_DIR@/doc/doxygen.log
INPUT = @CMAKE_SOURCE_DIR@/include \
@CMAKE_SOURCE_DIR@/doc/additionalDoc
-IMAGE_PATH = @CMAKE_SOURCE_DIR@/doc/pictures \
- @CMAKE_SOURCE_DIR@/doc/figures
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
@@ -413,7 +411,7 @@ COLS_IN_ALPHA_INDEX = 4
# Doxygen will copy the logo to the output directory.
PROJECT_LOGO = @PROJECT_SOURCE_DIR@/doc/pictures/sot.png
-HTML_EXTRA_FILES += sot.png
+HTML_EXTRA_FILES += @PROJECT_SOURCE_DIR@/doc/pictures/sot.png
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
@@ -427,7 +425,7 @@ HTML_EXTRA_FILES += sot.png
# changing the value of configuration settings such as GENERATE_TREEVIEW!
HTML_HEADER = @PROJECT_SOURCE_DIR@/doc/header.html
-HTML_EXTRA_FILES += @PROJECT_SOURCE_DIR@/doc/sot.ico
+HTML_EXTRA_FILES += @PROJECT_SOURCE_DIR@/doc/pictures/sot.ico
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
diff --git a/doc/additionalDoc/debug-logger.h b/doc/additionalDoc/debug-logger.h
index cbbdc77..0fc6403 100644
--- a/doc/additionalDoc/debug-logger.h
+++ b/doc/additionalDoc/debug-logger.h
@@ -26,7 +26,7 @@ It is possible to set the output stream of the messages inside a file:
\section sec_use_rt_logger Using the rt_logger
-\newcode
+\code
// Somewhere in your library
dgRTLOG() << "your message. Prefer to use \n than std::endl."
\endcode
diff --git a/doc/additionalDoc/introduction.h b/doc/additionalDoc/introduction.h
index 0d74961..e7e4c5e 100644
--- a/doc/additionalDoc/introduction.h
+++ b/doc/additionalDoc/introduction.h
@@ -62,6 +62,6 @@ load classes of entities and create instances of entities.</p>
\li Type-safe connection of input and output signals
\li On-demand signal computation as well as a caching system for signal values
allow fast computation of signal values, which is a critical point for real-time
-systems\n See \ref scriptingabout
+systems\n
*/
diff --git a/doc/figures/Concept-Software-Fig.png b/doc/pictures/Concept-Software-Fig.png
similarity index 100%
rename from doc/figures/Concept-Software-Fig.png
rename to doc/pictures/Concept-Software-Fig.png
diff --git a/doc/figures/entity.png b/doc/pictures/entity.png
similarity index 100%
rename from doc/figures/entity.png
rename to doc/pictures/entity.png
diff --git a/doc/figures/entity.svg b/doc/pictures/entity.svg
similarity index 100%
rename from doc/figures/entity.svg
rename to doc/pictures/entity.svg
diff --git a/doc/figures/use-case.png b/doc/pictures/use-case.png
similarity index 100%
rename from doc/figures/use-case.png
rename to doc/pictures/use-case.png
diff --git a/include/dynamic-graph/logger.h b/include/dynamic-graph/logger.h
index a4d151c..a89d321 100644
--- a/include/dynamic-graph/logger.h
+++ b/include/dynamic-graph/logger.h
@@ -206,6 +206,7 @@ public:
* allows it. The lineId is used to identify the point where sendMsg is
* called so that streaming messages are printed only every streamPrintPeriod
* iterations.
+ * \param type specifies the verbosity level, for instance MSG_TYPE_DEBUG
* \param lineId typically __FILE__ ":" BOOST_PP_STRINGIZE(__LINE__)
*/
RTLoggerStream stream(MsgType type, const std::string &lineId = "") {
@@ -265,8 +266,8 @@ protected:
inline bool isStreamMsg(MsgType m) { return (m & MSG_TYPE_STREAM_BIT); }
- /** Check whether a message of type \m and from \c lineId should be accepted.
- * \note If \c is a stream type, the internal counter associated to \c lineId
+ /** Check whether a message of type \p m and from \p c lineId should be accepted.
+ * \note If \p m is a stream type, the internal counter associated to \p lineId
* is updated.
*/
bool acceptMsg(MsgType m, const std::string &lineId) {
diff --git a/include/dynamic-graph/real-time-logger-def.h b/include/dynamic-graph/real-time-logger-def.h
index a1f564f..ea48eba 100644
--- a/include/dynamic-graph/real-time-logger-def.h
+++ b/include/dynamic-graph/real-time-logger-def.h
@@ -27,7 +27,7 @@ public:
/// Write to an ostream object.
///
-/// The easieast is to use the macro \ref dgADD_OSTREAM_TO_RTLOG(ostr) where
+/// The easieast is to use the macro dgADD_OSTREAM_TO_RTLOG(ostr) where
/// `ostr` can be `std::cout` or an std::ofstream...
class LoggerIOStream : public LoggerStream {
public:
--
GitLab