changeset
update general web documentation structure
Tue, 20 Jun 2023 19:04:07 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Tue, 20 Jun 2023 19:04:07 +0200
- changeset 716
- bab81cf591a5
- parent 715
- ab9d03750630
- child 717
- aa17be68fc66
update general web documentation structure
1.1 --- a/docs/src/CMakeLists.txt Tue Jun 20 19:00:52 2023 +0200 1.2 +++ b/docs/src/CMakeLists.txt Tue Jun 20 19:04:07 2023 +0200 1.3 @@ -28,7 +28,7 @@ 1.4 1.5 set(PANDOC_DESTDIR ${CMAKE_BINARY_DIR}/docs/web) 1.6 set(PANDOC_ARGS -c ucx.css -B header.html -A footer.html -T 'UAP Common Extensions') 1.7 -set(PANDOC_SRC index.md license.md install.md) 1.8 +set(PANDOC_SRC index.md license.md install.md features.md) 1.9 set(LOGO_PATH ../../uaplogo.png) 1.10 1.11 if (NOT EXISTS ${PANDOC_EXECUTABLE})
2.1 --- a/docs/src/header-ucx2.html Tue Jun 20 19:00:52 2023 +0200 2.2 +++ b/docs/src/header-ucx2.html Tue Jun 20 19:04:07 2023 +0200 2.3 @@ -18,21 +18,22 @@ 2.4 <div class="nav"> 2.5 <h3>Documentation</h3> 2.6 <ul> 2.7 - <li><a href="modules.html">Modules</a> 2.8 + <li><a href="modules.html">UCX 3</a> 2.9 + <li><a href="modules-ucx2.html">Modules</a> 2.10 <ul> 2.11 - <li><a href="modules.html#allocator">Allocator</a></li> 2.12 - <li><a href="modules.html#array">Array</a></li> 2.13 - <li><a href="modules.html#avl-tree">AVL Tree</a></li> 2.14 - <li><a href="modules.html#buffer">Buffer</a></li> 2.15 - <li><a href="modules.html#list">List</a></li> 2.16 - <li><a href="modules.html#logging">Logging</a></li> 2.17 - <li><a href="modules.html#map">Map</a></li> 2.18 - <li><a href="modules.html#memory-pool">Memory Pool</a></li> 2.19 - <li><a href="modules.html#properties">Properties</a></li> 2.20 - <li><a href="modules.html#stack">Stack</a></li> 2.21 - <li><a href="modules.html#string">String</a></li> 2.22 - <li><a href="modules.html#testing">Testing</a></li> 2.23 - <li><a href="modules.html#utilities">Utilities</a></li> 2.24 + <li><a href="modules-ucx2.html#allocator">Allocator</a></li> 2.25 + <li><a href="modules-ucx2.html#array">Array</a></li> 2.26 + <li><a href="modules-ucx2.html#avl-tree">AVL Tree</a></li> 2.27 + <li><a href="modules-ucx2.html#buffer">Buffer</a></li> 2.28 + <li><a href="modules-ucx2.html#list">List</a></li> 2.29 + <li><a href="modules-ucx2.html#logging">Logging</a></li> 2.30 + <li><a href="modules-ucx2.html#map">Map</a></li> 2.31 + <li><a href="modules-ucx2.html#memory-pool">Memory Pool</a></li> 2.32 + <li><a href="modules-ucx2.html#properties">Properties</a></li> 2.33 + <li><a href="modules-ucx2.html#stack">Stack</a></li> 2.34 + <li><a href="modules-ucx2.html#string">String</a></li> 2.35 + <li><a href="modules-ucx2.html#testing">Testing</a></li> 2.36 + <li><a href="modules-ucx2.html#utilities">Utilities</a></li> 2.37 </ul> 2.38 </li> 2.39 <li><a target="_blank" href="api-2.1/index.html">API Reference</a></li>
3.1 --- a/docs/src/header.html Tue Jun 20 19:00:52 2023 +0200 3.2 +++ b/docs/src/header.html Tue Jun 20 19:04:07 2023 +0200 3.3 @@ -18,9 +18,21 @@ 3.4 <div class="nav"> 3.5 <h3>Documentation</h3> 3.6 <ul> 3.7 - <li>Under construction...</li> 3.8 + <li><a href="features.html">Features</a> 3.9 + <ul> 3.10 + <li><a href="features.html#allocator">Allocator</a></li> 3.11 + <li><a href="features.html#string">String</a></li> 3.12 + <li><a href="features.html#buffer">Buffer</a></li> 3.13 + <li><a href="features.html#iterator">Iterator</a></li> 3.14 + <li><a href="features.html#collection">Collection</a></li> 3.15 + <li><a href="features.html#list">List</a></li> 3.16 + <li><a href="features.html#map">Map</a></li> 3.17 + <li><a href="features.html#memory-pool">Memory Pool</a></li> 3.18 + <li><a href="features.html#utilities">Utilities</a></li> 3.19 + </ul> 3.20 + </li> 3.21 <li><a target="_blank" href="api/index.html">API Reference</a></li> 3.22 - <li><a href="modules-ucx2.html">UCX 2.1</a> 3.23 + <li><a href="modules-ucx2.html">UCX 2.1</a></li> 3.24 </ul> 3.25 </div> 3.26 <div class="nav">
4.1 --- a/docs/src/index.md Tue Jun 20 19:00:52 2023 +0200 4.2 +++ b/docs/src/index.md Tue Jun 20 19:04:07 2023 +0200 4.3 @@ -5,11 +5,9 @@ 4.4 Welcome to the UAP Common Extensions. 4.5 4.6 With this library we provide useful data structures and algorithms for common 4.7 -programmatic tasks in the C language. By design the features are divided into 4.8 -modules to minimize the library footprint. Using the build files you can create 4.9 -a static and a shared lib containing all modules, but you may also use the UCX 4.10 -sources in your project and compile specific modules by yourself to further 4.11 -minimize the footprint. 4.12 +programmatic tasks in the C language. Using the build files you can create 4.13 +a static and a shared lib containing all units, but you may also use the UCX 4.14 +sources in your project and compile specific units by yourself. 4.15 4.16 If you want to use this library, you can [download and install](install.html) 4.17 the recent version. 4.18 @@ -31,7 +29,14 @@ 4.19 4.20 ### Version 3.0 4.21 4.22 - * under construction... 4.23 + * complete redesign from scratch 4.24 + * collections can now store copies of objects and not just pointers 4.25 + * collections are now dynamically implemented 4.26 + * users of the library can specify own implementations of collections that work with the UCX API 4.27 + * low level API for custom lists that do not use the UCX structures 4.28 + * various fixes and improvements 4.29 + * drops some other, rarely used, features 4.30 + * removes testing implementation from the lib 4.31 4.32 ### Version 2.1 - 2019-12-30 4.33
5.1 --- a/docs/src/license.md Tue Jun 20 19:00:52 2023 +0200 5.2 +++ b/docs/src/license.md Tue Jun 20 19:04:07 2023 +0200 5.3 @@ -2,7 +2,7 @@ 5.4 title: License 5.5 --- 5.6 5.7 -Copyright 2021 Mike Becker, Olaf Wintermann. All rights reserved. 5.8 +Copyright 2017 - 2023 ⓒ Mike Becker, Olaf Wintermann. All rights reserved. 5.9 5.10 Redistribution and use in source and binary forms, with or without 5.11 modification, are permitted provided that the following conditions are met:
