Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ A multi-platform C99 utility library that exposes common building blocks β€” col
[![Language: C99](https://img.shields.io/badge/Language-C99-blue.svg)](https://en.wikipedia.org/wiki/C99)
[![Build System: CMake](https://img.shields.io/badge/Build-CMake%20%E2%89%A5%203.10-064F8C.svg)](https://cmake.org/)
[![Platforms](https://img.shields.io/badge/Platforms-Linux%20%7C%20macOS%20%7C%20Windows-lightgrey.svg)](#requirements)
[![API reference](https://img.shields.io/badge/docs-API%20reference-brightgreen.svg)](https://xcomart.github.io/libcmutils/api/)

πŸ“– **[API reference](https://xcomart.github.io/libcmutils/api/)** β€” every type and method, grouped by
subject. This page is the guided tour; that one is the lookup.

---

Expand Down Expand Up @@ -1116,14 +1120,19 @@ of them bind ports or reach the network.

## API reference

The sections above are prose. The generated reference is the same API organized for lookup β€” grouped
by subject, built from the doc comments in `src/libcmutils.h`:
**<https://xcomart.github.io/libcmutils/api/>**

The sections above are prose. The reference is the same API organized for lookup β€” every type and
method grouped into eighteen subjects, generated from the doc comments in `src/libcmutils.h` and
rebuilt on every push that touches them.

To build it locally instead:

```bash
cd doc && doxygen # or: cmake --build build --target docs
```

Open `doc/html/index.html`. See [doc/README.md](doc/README.md) for what the topics contain.
That writes `doc/html/index.html`. See [doc/README.md](doc/README.md) for what the topics contain.

## Project structure

Expand Down
4 changes: 4 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# API reference

**Published at <https://xcomart.github.io/libcmutils/api/>**, rebuilt by the
`Docs` workflow on every push that touches the header, this directory, the
README or the Jekyll config.

The reference is generated from the doc comments in
[`src/libcmutils.h`](../src/libcmutils.h), which is the whole public API β€” the
`.c` files are implementation and are deliberately left out.
Expand Down
15 changes: 12 additions & 3 deletions src/libcmutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,18 @@ SOFTWARE.
*
* @section mp_where Where to look
*
* The <b>Modules</b> list groups the API by subject. The project README
* covers the same ground in prose, and @c samples/ holds one annotated
* program per subject.
* <b>Topics</b>, in the bar above, groups the API by subject - start there
* if you know roughly what you need. <b>Data Structures</b> lists the object
* types, and the search box finds anything by name.
*
* Elsewhere:
*
* - <a href="https://xcomart.github.io/libcmutils/">Project page</a> - the
* same API in prose, with the reasoning behind the conventions.
* - <a href="https://github.com/xcomart/libcmutils">Repository</a> - source,
* issues and releases.
* - <a href="https://github.com/xcomart/libcmutils/tree/master/samples">
* Samples</a> - one annotated, runnable program per subject.
*/

#ifndef LIBCMUTILS_H__
Expand Down
Loading