Skip to content

Commit

Permalink
* Removing doxygen warnings in several include files
Browse files Browse the repository at this point in the history
* Attempting yet another change to conf.py to try to overwrite the damage sphinx is doing in readthedocs
  • Loading branch information
jredmondson committed Dec 23, 2023
1 parent 6eab418 commit f36cd85
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
5 changes: 3 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
html_extra_path = ['build/html']
html_extra_path = ['_readthedocs/html']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand All @@ -101,7 +101,8 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []
#html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
18 changes: 13 additions & 5 deletions include/madara/knowledge/KnowledgeRecord.h
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,8 @@ class MADARA_EXPORT KnowledgeRecord
* Construct using CircularBuffer directly. This buffer will be treated
* as the history of this record, and used as such going forward.
*
* @params buffer buffer that will be copied into this record
* @param buffer buffer that will be copied into this record
* @param logger the logger to use for logging
**/
explicit KnowledgeRecord(const CircBuf& buffer,
logger::Logger& logger = *logger::global_logger.get());
Expand All @@ -275,15 +276,22 @@ class MADARA_EXPORT KnowledgeRecord
* Construct using CircularBuffer directly. This buffer will be treated
* as the history of this record, and used as such going forward.
*
* @params buffer buffer that will be moved into this record
* @param buffer buffer that will be copied into this record
* @param logger the logger to use for logging
**/
explicit KnowledgeRecord(CircBuf&& buffer,
logger::Logger& logger = *logger::global_logger.get()) noexcept;

/* copy constructor */
/**
* copy constructor
* @param rhs value to copy
*/
KnowledgeRecord(const KnowledgeRecord& rhs);

/* move constructor */
/**
* move constructor
* @param rhs value to copy
**/
KnowledgeRecord(KnowledgeRecord&& rhs) noexcept;

/* destructor */
Expand Down Expand Up @@ -387,7 +395,7 @@ class MADARA_EXPORT KnowledgeRecord
* buffer will be treated as the history of this record, and used as such
* going forward.
*
* @params args arguments forwarded to the
* @param args arguments forwarded to the
* madara::utility::CircularBuffer constructor
**/
template<typename... Args>
Expand Down
2 changes: 0 additions & 2 deletions include/madara/knowledge/containers/CircularBufferConsumer.h
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ class CircularBufferConsumer
* Constructor
* @param name name of the integer in the knowledge base
* @param knowledge the knowledge base that will contain the vector
* @param settings settings for evaluating the vector
* @throw exceptions::NameException bad name ("")
**/
CircularBufferConsumer(const std::string& name, KnowledgeBase& knowledge);
Expand All @@ -52,7 +51,6 @@ class CircularBufferConsumer
* Constructor
* @param name the name of the map within the variable context
* @param knowledge the variable context
* @param settings settings to apply by default
* @throw exceptions::NameException bad name ("")
**/
CircularBufferConsumer(const std::string& name, Variables& knowledge);
Expand Down
2 changes: 1 addition & 1 deletion include/madara/utility/StlHelper.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

/**
* Macro which generates feature testing traits, to allow enabling features
* based on what a given type supports. The tests provide ::value member
* based on what a given type supports. The tests provide value member
* which is true if the given expr can compile correctly with the given
* type; false otherwise
*
Expand Down

0 comments on commit f36cd85

Please sign in to comment.