[doc] Fix documentation (wrong image references + error on doxygen.log)

Author: olivier-stasse

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

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

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 
 
 */

doc/figures/Concept-Software-Fig.png renamed to doc/pictures/Concept-Software-Fig.png

@@ -206,6 +206,7 @@ class Logger {
    * 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 @@ class Logger {
 
   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) {

doc/figures/entity.png renamed to doc/pictures/entity.png

@@ -27,7 +27,7 @@ class LoggerStream {
 
 /// 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: