From 952292462a8384ad74bbf4a390ccb67300901de6 Mon Sep 17 00:00:00 2001 From: Leonardo Date: Thu, 16 Apr 2020 02:08:42 -0300 Subject: [PATCH] Update documentation --- docs/Examples/examples.html | 2 +- docs/Introduction/how_to_install.html | 2 +- docs/Introduction/how_to_use_the_library.html | 7 +- docs/Introduction/introduction.html | 2 +- docs/Introduction/library_structure.html | 2 +- .../understanding_the_library.html | 2 +- docs/Introduction/why_this_library.html | 4 +- ...verview.html => collections_overview.html} | 10 +- docs/Overview/features_overview.html | 227 ++++++++ .../features.html => Overview/index.html} | 12 +- docs/cmc/deque.h/index.html | 302 +++++++++++ docs/cmc/index.html | 238 +++++++++ docs/cor/callbacks/index.html | 269 ++++++++++ docs/cor/custom_allocation/index.html | 299 +++++++++++ .../functions_table/index.html} | 113 +++- .../callbacks.html => cor/index.html} | 24 +- docs/cor/iterators/index.html | 222 ++++++++ .../two_way_iterators.html => dev/index.html} | 17 +- docs/index.html | 2 +- docs/print.html | 502 ++++++++++++++++-- .../custom_allocation.html => sac/index.html} | 38 +- docs/searchindex.js | 2 +- docs/searchindex.json | 2 +- docs/utl/assert.h/generic_assertions.html | 2 +- docs/utl/assert.h/index.html | 2 +- docs/utl/assert.h/overview.html | 2 +- docs/utl/assert.h/valued_assertions.html | 2 +- docs/utl/foreach.h/index.html | 37 +- docs/utl/futils.h/index.html | 293 ++++++++++ docs/utl/index.html | 17 +- docs/utl/log.h/configuration.html | 2 +- docs/utl/log.h/index.html | 6 +- docs/utl/log.h/log_functions.html | 2 +- docs/utl/log.h/meanings.html | 2 +- docs/utl/test.h/index.html | 2 +- docs/utl/timer.h/index.html | 2 +- documentation/Features/callbacks.md | 13 - documentation/Features/custom_allocation.md | 8 - documentation/Features/features.md | 3 - .../Introduction/how_to_use_the_library.md | 2 + .../Introduction/why_this_library.md | 2 +- .../{overview.md => collections_overview.md} | 0 documentation/Overview/features_overview.md | 10 + documentation/Overview/index.md | 3 + documentation/SUMMARY.md | 19 +- documentation/cmc/deque.h/index.md | 86 +++ documentation/cmc/index.md | 27 + documentation/cor/callbacks/index.md | 60 +++ documentation/cor/custom_allocation/index.md | 91 ++++ .../functions_table/index.md} | 72 ++- documentation/cor/index.md | 4 + .../iterators/index.md} | 2 +- documentation/dev/index.md | 3 + documentation/sac/index.md | 23 + documentation/utl/foreach.h/index.md | 34 +- documentation/utl/futils.h/index.md | 87 +++ documentation/utl/index.md | 11 +- 57 files changed, 3027 insertions(+), 204 deletions(-) rename docs/Overview/{overview.html => collections_overview.html} (78%) create mode 100644 docs/Overview/features_overview.html rename docs/{Features/features.html => Overview/index.html} (72%) create mode 100644 docs/cmc/deque.h/index.html create mode 100644 docs/cmc/index.html create mode 100644 docs/cor/callbacks/index.html create mode 100644 docs/cor/custom_allocation/index.html rename docs/{Features/functions_table.html => cor/functions_table/index.html} (64%) rename docs/{Features/callbacks.html => cor/index.html} (71%) create mode 100644 docs/cor/iterators/index.html rename docs/{Features/two_way_iterators.html => dev/index.html} (71%) rename docs/{Features/custom_allocation.html => sac/index.html} (67%) create mode 100644 docs/utl/futils.h/index.html delete mode 100644 documentation/Features/callbacks.md delete mode 100644 documentation/Features/custom_allocation.md delete mode 100644 documentation/Features/features.md rename documentation/Overview/{overview.md => collections_overview.md} (100%) create mode 100644 documentation/Overview/features_overview.md create mode 100644 documentation/Overview/index.md create mode 100644 documentation/cmc/deque.h/index.md create mode 100644 documentation/cmc/index.md create mode 100644 documentation/cor/callbacks/index.md create mode 100644 documentation/cor/custom_allocation/index.md rename documentation/{Features/functions_table.md => cor/functions_table/index.md} (66%) create mode 100644 documentation/cor/index.md rename documentation/{Features/two_way_iterators.md => cor/iterators/index.md} (96%) create mode 100644 documentation/dev/index.md create mode 100644 documentation/sac/index.md create mode 100644 documentation/utl/futils.h/index.md diff --git a/docs/Examples/examples.html b/docs/Examples/examples.html index 25f636b..9850512 100644 --- a/docs/Examples/examples.html +++ b/docs/Examples/examples.html @@ -81,7 +81,7 @@ diff --git a/docs/Introduction/how_to_install.html b/docs/Introduction/how_to_install.html index 950602f..8b372df 100644 --- a/docs/Introduction/how_to_install.html +++ b/docs/Introduction/how_to_install.html @@ -81,7 +81,7 @@ diff --git a/docs/Introduction/how_to_use_the_library.html b/docs/Introduction/how_to_use_the_library.html index 0874b26..8b26a45 100644 --- a/docs/Introduction/how_to_use_the_library.html +++ b/docs/Introduction/how_to_use_the_library.html @@ -81,7 +81,7 @@ @@ -150,6 +150,7 @@

How to Use the Library

The C Macro Collections Library comes with very powerful data structures and they are only one macro away from you.

+

TODO

@@ -162,7 +163,7 @@ - @@ -180,7 +181,7 @@ - diff --git a/docs/Introduction/introduction.html b/docs/Introduction/introduction.html index 3907f02..eb6865f 100644 --- a/docs/Introduction/introduction.html +++ b/docs/Introduction/introduction.html @@ -81,7 +81,7 @@ diff --git a/docs/Introduction/library_structure.html b/docs/Introduction/library_structure.html index d965487..ea8a560 100644 --- a/docs/Introduction/library_structure.html +++ b/docs/Introduction/library_structure.html @@ -81,7 +81,7 @@ diff --git a/docs/Introduction/understanding_the_library.html b/docs/Introduction/understanding_the_library.html index c8b90f4..55aa864 100644 --- a/docs/Introduction/understanding_the_library.html +++ b/docs/Introduction/understanding_the_library.html @@ -81,7 +81,7 @@ diff --git a/docs/Introduction/why_this_library.html b/docs/Introduction/why_this_library.html index e3046c5..00d8f5b 100644 --- a/docs/Introduction/why_this_library.html +++ b/docs/Introduction/why_this_library.html @@ -81,7 +81,7 @@ @@ -164,7 +164,7 @@
  • Nesting - Collections can be nested (List of Lists, HashSet of Stacks, etc);
  • One macro to rule them all - Only one macro to generate everything and that's it.
    • -

    and many other powerful features (see Features).

    +

    and many other powerful features (see Features).

    diff --git a/docs/Overview/overview.html b/docs/Overview/collections_overview.html similarity index 78% rename from docs/Overview/overview.html rename to docs/Overview/collections_overview.html index e721ba2..a0864aa 100644 --- a/docs/Overview/overview.html +++ b/docs/Overview/collections_overview.html @@ -81,7 +81,7 @@ @@ -172,13 +172,13 @@