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
--- a/docs/src/CMakeLists.txt Tue Jun 20 19:00:52 2023 +0200 +++ b/docs/src/CMakeLists.txt Tue Jun 20 19:04:07 2023 +0200 @@ -28,7 +28,7 @@ set(PANDOC_DESTDIR ${CMAKE_BINARY_DIR}/docs/web) set(PANDOC_ARGS -c ucx.css -B header.html -A footer.html -T 'UAP Common Extensions') -set(PANDOC_SRC index.md license.md install.md) +set(PANDOC_SRC index.md license.md install.md features.md) set(LOGO_PATH ../../uaplogo.png) if (NOT EXISTS ${PANDOC_EXECUTABLE})
--- a/docs/src/header-ucx2.html Tue Jun 20 19:00:52 2023 +0200 +++ b/docs/src/header-ucx2.html Tue Jun 20 19:04:07 2023 +0200 @@ -18,21 +18,22 @@ <div class="nav"> <h3>Documentation</h3> <ul> - <li><a href="modules.html">Modules</a> + <li><a href="modules.html">UCX 3</a> + <li><a href="modules-ucx2.html">Modules</a> <ul> - <li><a href="modules.html#allocator">Allocator</a></li> - <li><a href="modules.html#array">Array</a></li> - <li><a href="modules.html#avl-tree">AVL Tree</a></li> - <li><a href="modules.html#buffer">Buffer</a></li> - <li><a href="modules.html#list">List</a></li> - <li><a href="modules.html#logging">Logging</a></li> - <li><a href="modules.html#map">Map</a></li> - <li><a href="modules.html#memory-pool">Memory Pool</a></li> - <li><a href="modules.html#properties">Properties</a></li> - <li><a href="modules.html#stack">Stack</a></li> - <li><a href="modules.html#string">String</a></li> - <li><a href="modules.html#testing">Testing</a></li> - <li><a href="modules.html#utilities">Utilities</a></li> + <li><a href="modules-ucx2.html#allocator">Allocator</a></li> + <li><a href="modules-ucx2.html#array">Array</a></li> + <li><a href="modules-ucx2.html#avl-tree">AVL Tree</a></li> + <li><a href="modules-ucx2.html#buffer">Buffer</a></li> + <li><a href="modules-ucx2.html#list">List</a></li> + <li><a href="modules-ucx2.html#logging">Logging</a></li> + <li><a href="modules-ucx2.html#map">Map</a></li> + <li><a href="modules-ucx2.html#memory-pool">Memory Pool</a></li> + <li><a href="modules-ucx2.html#properties">Properties</a></li> + <li><a href="modules-ucx2.html#stack">Stack</a></li> + <li><a href="modules-ucx2.html#string">String</a></li> + <li><a href="modules-ucx2.html#testing">Testing</a></li> + <li><a href="modules-ucx2.html#utilities">Utilities</a></li> </ul> </li> <li><a target="_blank" href="api-2.1/index.html">API Reference</a></li>
--- a/docs/src/header.html Tue Jun 20 19:00:52 2023 +0200 +++ b/docs/src/header.html Tue Jun 20 19:04:07 2023 +0200 @@ -18,9 +18,21 @@ <div class="nav"> <h3>Documentation</h3> <ul> - <li>Under construction...</li> + <li><a href="features.html">Features</a> + <ul> + <li><a href="features.html#allocator">Allocator</a></li> + <li><a href="features.html#string">String</a></li> + <li><a href="features.html#buffer">Buffer</a></li> + <li><a href="features.html#iterator">Iterator</a></li> + <li><a href="features.html#collection">Collection</a></li> + <li><a href="features.html#list">List</a></li> + <li><a href="features.html#map">Map</a></li> + <li><a href="features.html#memory-pool">Memory Pool</a></li> + <li><a href="features.html#utilities">Utilities</a></li> + </ul> + </li> <li><a target="_blank" href="api/index.html">API Reference</a></li> - <li><a href="modules-ucx2.html">UCX 2.1</a> + <li><a href="modules-ucx2.html">UCX 2.1</a></li> </ul> </div> <div class="nav">
--- a/docs/src/index.md Tue Jun 20 19:00:52 2023 +0200 +++ b/docs/src/index.md Tue Jun 20 19:04:07 2023 +0200 @@ -5,11 +5,9 @@ Welcome to the UAP Common Extensions. With this library we provide useful data structures and algorithms for common -programmatic tasks in the C language. By design the features are divided into -modules to minimize the library footprint. Using the build files you can create -a static and a shared lib containing all modules, but you may also use the UCX -sources in your project and compile specific modules by yourself to further -minimize the footprint. +programmatic tasks in the C language. Using the build files you can create +a static and a shared lib containing all units, but you may also use the UCX +sources in your project and compile specific units by yourself. If you want to use this library, you can [download and install](install.html) the recent version. @@ -31,7 +29,14 @@ ### Version 3.0 - * under construction... + * complete redesign from scratch + * collections can now store copies of objects and not just pointers + * collections are now dynamically implemented + * users of the library can specify own implementations of collections that work with the UCX API + * low level API for custom lists that do not use the UCX structures + * various fixes and improvements + * drops some other, rarely used, features + * removes testing implementation from the lib ### Version 2.1 - 2019-12-30
--- a/docs/src/license.md Tue Jun 20 19:00:52 2023 +0200 +++ b/docs/src/license.md Tue Jun 20 19:04:07 2023 +0200 @@ -2,7 +2,7 @@ title: License --- -Copyright 2021 Mike Becker, Olaf Wintermann. All rights reserved. +Copyright 2017 - 2023 ⓒ Mike Becker, Olaf Wintermann. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
