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
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
modules/api/pages/
modules/api/nav.adoc
24 changes: 24 additions & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: rsl
version: ~
title: Reflection Support Library

ext:
collector:
- worktree:
keep: until:exit
run:
- command: claudoc generate ../include modules/api --verbose
dir: .
scan:
dir: .
files: '**/*'
ignore: []
nav:
- modules/ROOT/nav.adoc
- modules/annotation/nav.adoc
- modules/collections/nav.adoc
- modules/platform/nav.adoc
- modules/serialization/nav.adoc
- modules/utilities/nav.adoc
- modules/api/nav.adoc

Empty file added docs/modules/ROOT/nav.adoc
Empty file.
9 changes: 9 additions & 0 deletions docs/modules/ROOT/pages/brief.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This project contains reimplementations of various standard library facilities
and other utilities to assist with reflective code.

This includes reimplementations of various containers as structural types,
several useful reflective queries, reusable annotations, experimental additions
to existing facilities and general infrastructure commonly needed in reflective,
metaprogramming-heavy codebases.

The rsl project is released under the 0-BSD license.
26 changes: 26 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
= **R**eflection **S**upport **L**ibrary

include::brief.adoc[]

[WARNING]
====
This documentation is very incomplete and might be partially broken.

Since popular documentation generators for C++ do not yet support reflective
code, the API documentation is currently generated using a
https://github.com/tsche/claudoc[temporary tool].

Since this is only a temporary fix, that tool is largely generated by LLMs.
====

Here's an overview:

:leveloffset: +1

include::annotation:index.adoc[]
include::collections:index.adoc[]
include::platform:index.adoc[]
include::serialization:index.adoc[]
include::utilities:index.adoc[]

:leveloffset: -1
1 change: 1 addition & 0 deletions docs/modules/annotation/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* xref:index.adoc[]
1 change: 1 addition & 0 deletions docs/modules/annotation/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Annotation Library
1 change: 1 addition & 0 deletions docs/modules/api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is the target folder for automatically generated API documentation. Do not check in anything from this folder.
5 changes: 5 additions & 0 deletions docs/modules/collections/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.xref:index.adoc[]
* xref:api:include/rsl/span.adoc[<rsl/span>]
* xref:api:include/rsl/string_view.adoc[<rsl/string_view>]
* xref:api:include/rsl/tuple.adoc[<rsl/tuple>]
* xref:api:include/rsl/variant.adoc[<rsl/variant>]
1 change: 1 addition & 0 deletions docs/modules/collections/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Collections library
1 change: 1 addition & 0 deletions docs/modules/platform/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* xref:index.adoc[]
1 change: 1 addition & 0 deletions docs/modules/platform/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Platform support library
4 changes: 4 additions & 0 deletions docs/modules/serialization/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.xref:index.adoc[]
* xref:design.adoc[]
* xref:customization.adoc[]
* xref:api:include/rsl/repr.adoc[<rsl/repr>]
1 change: 1 addition & 0 deletions docs/modules/serialization/pages/customization.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Customization
1 change: 1 addition & 0 deletions docs/modules/serialization/pages/design.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Design
1 change: 1 addition & 0 deletions docs/modules/serialization/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Serialization library
5 changes: 5 additions & 0 deletions docs/modules/utilities/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.xref:index.adoc[]
* xref:api:include/rsl/meta.adoc[<rsl/meta>]
* xref:api:include/rsl/meta_traits.adoc[<rsl/meta_traits>]
* xref:api:include/rsl/source_location.adoc[<rsl/source_location>]
* xref:api:include/rsl/trie.adoc[<rsl/trie>]
1 change: 1 addition & 0 deletions docs/modules/utilities/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Utilities library
4 changes: 4 additions & 0 deletions include/rsl/format
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
#pragma once
#include <concepts>
#include <string_view>
#include <utility>

#include "_impl/format/fmt_parser.hpp"
#include "_impl/format/style.hpp"

Expand Down
Loading