MatthiasQuintern/gz-cpp-util
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improved documentation

Browse Source
This commit is contained in:
matthias@arch 2022-11-01 18:18:07 +01:00
parent 7e7e46c7d4
commit 5826df9afa
2 changed files with 17 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/.doxygen_config
View File

@ -856,7 +856,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = . container math util ../README.md .extranous_documentation INPUT = . container string ../README.md .extranous_documentation
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -1053,7 +1053,8 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub # (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output. # and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = ../README.md # USE_MDFILE_AS_MAINPAGE = ../README.md
USE_MDFILE_AS_MAINPAGE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to source browsing # Configuration options related to source browsing

46
src/.extranous_documentation.hpp
View File

@ -1,27 +1,23 @@
namespace gz { namespace gz {
// deactivated to use readme as mainpage /**
/*
* @mainpage * @mainpage
* @section main_about About * @section main_about About
* This c++20 library contains multiple useful functions, most of them are focused on working with strings. * This c++20 library contains multiple useful functions, most of them are focused on working with strings.
* *
* Please report bugs on the <a href="https://github.com/MatthiasQuintern/gz-cpp-util">github page</a>! * Please report bugs on the <a href="https://github.com/MatthiasQuintern/gz-cpp-util">github page</a>!
* *
* For the changelog, have a look at the @ref README.md "readme".
*
* @section main_features Features * @section main_features Features
* @subsubsection main_f1 1. Logger * -# @ref Log "extensive and extendable logger" using variadic templates to log @ref sc_toStringImplemented "almost anything"
* an @ref Log "extensive and extendable logger" using variadic templates to log almost anything * -# containers like a thread safe @ref Queue "queue" and a @ref RingBuffer "ringbuffer"
* @subsubsection main_f2 2. Container * -# @ref regex.hpp "regex that works with std::string_view"
* containers like a thread safe @ref Queue "queue" and a @ref RingBuffer "ringbuffer" * -# @subpage string_conversion "string <-> type conversion"
* @subsubsection main_f3 3. Regex * - @ref sc_toString "converting types to string" (including numbers, vectors, ranges, maps...)
* regex that works with std::string_view * - @ref sc_fromString "constructing types from string"
* @subsubsection main_f4 4. String type conversion
* - @ref sc_to_string "converting types to string" (including numbers, vectors, ranges, maps...)
* - @ref sc_from_string "constructing types from string"
* - @ref getIntOr "constructing types from string" or return fallback * - @ref getIntOr "constructing types from string" or return fallback
* @subsubsection main_f5 5. Settings Manager * -# @ref SettingsManager "Settings Manager" which can store settings of different types and load/save them from/to a file
* a @ref SettingsManager "settings manager" which can store settings of different types and load/save them from/to a file * -# @subpage gen-enum-str "a script that generates an array of strings for your enumerations", so that you can get the name of an enum value
* @subsubsection main_f6 6. Enum-String generation script (python)
* a script that generates an array of strings for your enumerations, so that you can get the name of an enum value
* *
* @section main_installation Installation * @section main_installation Installation
* @subsection main_i_linux Linux * @subsection main_i_linux Linux
@ -30,25 +26,11 @@ namespace gz {
* @subsection main_i_arch Arch Linux (ABS) * @subsection main_i_arch Arch Linux (ABS)
* - Download PKGBUILD: `wget https://raw.github.com/MatthiasQuintern/gz-cpp-util/main/PKGBUILD` * - Download PKGBUILD: `wget https://raw.github.com/MatthiasQuintern/gz-cpp-util/main/PKGBUILD`
* - Build and install with the Arch Build System: `makepkg -si` * - Build and install with the Arch Build System: `makepkg -si`
* @subsection main_i_docs Documentation
* The documentation for this library can be generated using **doxygen**.
* @code
* cd gz-cpp-util/src
* make docs
* firefox ../docs/html/index.html
* @endcode
* Replace `firefox` with your web browser.
* *
* @section main_usage Usage * @subsection main_i_usage Usage
* @subsection main_usage_lib Library
* - Add `-lgzutil` to your linker flags * - Add `-lgzutil` to your linker flags
* - Include the wanted header: `#include <gz-util/dir/header.hpp>` * - Include the wanted header: `#include <gz-util/dir/header.hpp>`
* *
* @subsection main_usage_p Enumeration-to-string script
* - The gen_enum_str.py script will be installed to `/usr/bin/gz-enum-str`.
* - Run `gz-enum-str -h` to list available options.
*
*
*/ */
@ -77,7 +59,7 @@ namespace gz {
* @section ges_usage Usage * @section ges_usage Usage
* The script was written for python 3(.10), so you will need to have that installed. * The script was written for python 3(.10), so you will need to have that installed.
* *
* @subsubsection ges_usage_installed With script installed * @subsection ges_usage_installed With script installed
* Depending on the installation method, it should either be in `/usr/bin` or `/usr/local/bin` which should both be in your `$PATH`. * Depending on the installation method, it should either be in `/usr/bin` or `/usr/local/bin` which should both be in your `$PATH`.
* Note that it will not have the `.py` ending! * Note that it will not have the `.py` ending!
* *
@ -86,7 +68,7 @@ namespace gz {
* gen-enum-str ~/c++/src/myheader.hpp * gen-enum-str ~/c++/src/myheader.hpp
* @endcode * @endcode
* *
* @subsubsection ges_usage_not_installed With script not installed * @subsection ges_usage_not_installed With script not installed
* If you do want to run the script on `~/c++/src/myheader.hpp`, with the script itself being located at `~/scripts/gen_enum_str.py`, run: * If you do want to run the script on `~/c++/src/myheader.hpp`, with the script itself being located at `~/scripts/gen_enum_str.py`, run:
* @code shell * @code shell
* python3 ~/scripts/gen_enum_str.py ~/c++/src/myheader.hpp * python3 ~/scripts/gen_enum_str.py ~/c++/src/myheader.hpp