Skip to content

Commit

Permalink
Improve doxygen
Browse files Browse the repository at this point in the history
* Use Doxygen groups for each group of header attributes, optional block
  values, flags, or any other logic grouping of definitions. This groups
  these definitions in the output as well as allows convenient anchors
  by which to refer to these groups from elsewhere.
* Reduce the mentions of "TR-31". The TR-31 specification is deprecated
  and therefore the name "TR-31" should only refer to the library itself
  or to types provided by the library. The actual key block concepts and
  functionality now involve multiple other specifications while only the
  library itself is still called "TR-31".
* Add tr31_strings.h to Doxygen generator
  • Loading branch information
leonlynch committed Dec 2, 2023
1 parent fa3f94d commit 5f1247a
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 51 deletions.
2 changes: 2 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ if(Doxygen_FOUND)
if(BUILD_DOCS)
doxygen_add_docs(docs
tr31.h
tr31_strings.h
ALL # build by default
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/src"
)
Expand All @@ -189,6 +190,7 @@ if(Doxygen_FOUND)
else()
doxygen_add_docs(docs
tr31.h
tr31_strings.h
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/src"
)
endif()
Expand Down
Loading

0 comments on commit 5f1247a

Please sign in to comment.