From 53f6202709fd244fbb4474a0ced103fc9bd25bdd Mon Sep 17 00:00:00 2001 From: Leonardo Date: Thu, 30 Apr 2020 23:39:09 -0300 Subject: [PATCH] Updating documentation --- docs/Examples/examples.html | 2 +- docs/Introduction/how_to_install.html | 2 +- docs/Introduction/how_to_use_the_library.html | 2 +- docs/Introduction/introduction.html | 2 +- docs/Introduction/library_structure.html | 2 +- .../understanding_the_library.html | 2 +- docs/Introduction/why_this_library.html | 2 +- docs/Overview/collections_overview.html | 2 +- docs/Overview/features_overview.html | 2 +- docs/Overview/files_overview.html | 4 +- docs/Overview/index.html | 2 +- docs/cmc/deque.h/functions.html | 277 ++++++++++++++++++ docs/cmc/deque.h/index.html | 12 +- docs/cmc/index.html | 2 +- docs/cor/callbacks/index.html | 2 +- docs/cor/custom_allocation/index.html | 2 +- docs/cor/error_codes/index.html | 2 +- docs/cor/functions_table/index.html | 2 +- docs/cor/index.html | 2 +- docs/cor/iterators/index.html | 2 +- docs/dev/index.html | 6 +- docs/index.html | 2 +- docs/print.html | 68 ++++- docs/sac/index.html | 2 +- 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 | 2 +- docs/utl/futils.h/index.html | 2 +- docs/utl/index.html | 2 +- docs/utl/log.h/configuration.html | 2 +- docs/utl/log.h/index.html | 2 +- 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/SUMMARY.md | 1 + documentation/cmc/deque.h/functions.md | 79 +++++ documentation/cmc/deque.h/index.md | 5 - 42 files changed, 459 insertions(+), 61 deletions(-) create mode 100644 docs/cmc/deque.h/functions.html create mode 100644 documentation/cmc/deque.h/functions.md diff --git a/docs/Examples/examples.html b/docs/Examples/examples.html index 9416042..bb81a8b 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 5048598..f257dd3 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 b943ac6..256aaad 100644 --- a/docs/Introduction/how_to_use_the_library.html +++ b/docs/Introduction/how_to_use_the_library.html @@ -81,7 +81,7 @@ diff --git a/docs/Introduction/introduction.html b/docs/Introduction/introduction.html index ed73aa8..e0c4894 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 1fca206..bc3f2d7 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 029cbd2..85dbf67 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 94d05c0..1700823 100644 --- a/docs/Introduction/why_this_library.html +++ b/docs/Introduction/why_this_library.html @@ -81,7 +81,7 @@ diff --git a/docs/Overview/collections_overview.html b/docs/Overview/collections_overview.html index 4179f87..73b6e29 100644 --- a/docs/Overview/collections_overview.html +++ b/docs/Overview/collections_overview.html @@ -81,7 +81,7 @@ diff --git a/docs/Overview/features_overview.html b/docs/Overview/features_overview.html index 07adede..49a6fd4 100644 --- a/docs/Overview/features_overview.html +++ b/docs/Overview/features_overview.html @@ -81,7 +81,7 @@ diff --git a/docs/Overview/files_overview.html b/docs/Overview/files_overview.html index 845fd68..eb385bb 100644 --- a/docs/Overview/files_overview.html +++ b/docs/Overview/files_overview.html @@ -81,7 +81,7 @@ @@ -163,7 +163,7 @@
  • ./list.h - A dynamic array
  • ./multimap.h - A map that accepts multiple keys based on a hash table
  • ./multiset.h - A multiset based on a hash table
    • -
  • ./queue.h - A FIFO based on circular dynamic array
    • +
  • ./queue.h - A FIFO based on a circular dynamic array
  • ./sortedlist.h - A sorted list based on a dynamic array
  • ./stack.h - A LIFO based on a dynamic array
  • ./treemap.h - A sorted map based on an AVL tree
    • diff --git a/docs/Overview/index.html b/docs/Overview/index.html index c8543c4..228cdbc 100644 --- a/docs/Overview/index.html +++ b/docs/Overview/index.html @@ -81,7 +81,7 @@ diff --git a/docs/cmc/deque.h/functions.html b/docs/cmc/deque.h/functions.html new file mode 100644 index 0000000..8115175 --- /dev/null +++ b/docs/cmc/deque.h/functions.html @@ -0,0 +1,277 @@ + + + + + + Functions.h - C Macro Collections + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + + + + + + + +
    +
    +

    Index

    +

    Deque

    +
      +
    • _new()
      • +
    • _new_custom()
      • +
    • _clear()
      • +
    • _free()
      • +
    • _customize()
      • +
    • _push_front()
      • +
    • _push_back()
      • +
    • _pop_front()
      • +
    • _front()
      • +
    • _back()
      • +
    • _contains()
      • +
    • _empty()
      • +
    • _full()
      • +
    • _count()
      • +
    • _capacity()
      • +
    • _flag()
      • +
    • _resize()
      • +
    • _copy_of()
      • +
    • _equals()
      • +
    • _to_string()
      • +
    • _print()
      • +
    +

    Deque Iterator

    +

    WIP.

    +

    _new()

    +

    Allocates on the heap and returns a new Deque with an internal capacity of the specified value. The Deque will be empty, using the default allocator cmc_alloc_node_default and no callbacks will be set, that is, callbacks will be set to NULL. Its flag will be initially cmc_flags.OK.

    +

    Declaration

    +

    struct SNAME *PFX##_new(size_t capacity, struct SNAME##_fval *f_val);

    +

    Parameters

    + + + +
    ParameterRequiredDescription
    size_t capacityYesThe initial Deque capacity
    struct SNAME##_fval *f_valYesA Functions Table for V
    +

    Returns

    + + + +
    ReturnsWhen
    struct SNAME *If operation was successful
    NULLIf allocation failed, if capacity is 0 or if f_val is NULL
    +

    _new_custom()

    +

    Like _new() but allows for custom allocation node and callbacks. The allocation node is optional. If present, the function will immediately use it to allocate the new Deque. If NULL, cmc_alloc_node_default will instead be used.

    +

    Declaration

    +
    struct SNAME *PFX##_new_custom(size_t capacity, struct SNAME##_fval *f_val, struct cmc_alloc_node *alloc, struct cmc_callbacks *callbacks);
+
    +

    Parameters

    + + + + + +
    ParameterRequiredDescription
    size_t capacityYesThe initial Deque capacity
    struct SNAME##_fval *f_valYesA Functions Table for V
    struct cmc_alloc_node *allocNoA custom allocation node
    struct cmc_callbacks *callbacksNoA custom callbacks struct
    +

    Returns

    + + + +
    ReturnsWhen
    struct SNAME *If operation was successful
    NULLIf allocation failed, if capacity is 0 or if f_val is NULL
    + +
    + + +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/cmc/deque.h/index.html b/docs/cmc/deque.h/index.html index be90a07..10f5a9d 100644 --- a/docs/cmc/deque.h/index.html +++ b/docs/cmc/deque.h/index.html @@ -81,7 +81,7 @@ @@ -181,13 +181,7 @@ struct SNAME##_fval *f_valFunctions table for the Value type. struct cmc_alloc_node *allocCustom allocation functions. struct cmc_callbacks *callbacksCallback functions. -it_start [1]Returns an iterator to the start of the Deque. -it_end [2]Returns an iterator to the end of the Deque. -
      -
    1. Full definition: struct SNAME##_iter (*it_start)(struct SNAME *);.
      2. -
    2. Full definition: struct SNAME##_iter (*it_end)(struct SNAME *);.
      3. -

    struct SNAME##_fval

    The Functions Table for V. Check out the Functions Table documentation here.

    struct SNAME##_iter

    @@ -243,7 +237,7 @@ - @@ -261,7 +255,7 @@ - diff --git a/docs/cmc/index.html b/docs/cmc/index.html index 4a08a89..a758583 100644 --- a/docs/cmc/index.html +++ b/docs/cmc/index.html @@ -81,7 +81,7 @@ diff --git a/docs/cor/callbacks/index.html b/docs/cor/callbacks/index.html index 62ce486..0fdcf31 100644 --- a/docs/cor/callbacks/index.html +++ b/docs/cor/callbacks/index.html @@ -81,7 +81,7 @@ diff --git a/docs/cor/custom_allocation/index.html b/docs/cor/custom_allocation/index.html index 7c53bd4..5390f91 100644 --- a/docs/cor/custom_allocation/index.html +++ b/docs/cor/custom_allocation/index.html @@ -81,7 +81,7 @@ diff --git a/docs/cor/error_codes/index.html b/docs/cor/error_codes/index.html index 8e35dad..e5e12c7 100644 --- a/docs/cor/error_codes/index.html +++ b/docs/cor/error_codes/index.html @@ -81,7 +81,7 @@ diff --git a/docs/cor/functions_table/index.html b/docs/cor/functions_table/index.html index 7385ecd..4194e66 100644 --- a/docs/cor/functions_table/index.html +++ b/docs/cor/functions_table/index.html @@ -81,7 +81,7 @@ diff --git a/docs/cor/index.html b/docs/cor/index.html index 6a849f8..1ff35a9 100644 --- a/docs/cor/index.html +++ b/docs/cor/index.html @@ -81,7 +81,7 @@ diff --git a/docs/cor/iterators/index.html b/docs/cor/iterators/index.html index f752e07..19fd38d 100644 --- a/docs/cor/iterators/index.html +++ b/docs/cor/iterators/index.html @@ -81,7 +81,7 @@ diff --git a/docs/dev/index.html b/docs/dev/index.html index 9dbf9ab..740beaf 100644 --- a/docs/dev/index.html +++ b/docs/dev/index.html @@ -81,7 +81,7 @@ @@ -156,7 +156,7 @@