From 384b58397df00b75680d6a523894bced9a795711 Mon Sep 17 00:00:00 2001 From: Chip Hogg Date: Sun, 27 Oct 2024 15:23:21 -0400 Subject: [PATCH] Document `fwd.hh` files --- docs/alternatives/index.md | 7 ++++++- docs/install.md | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/alternatives/index.md b/docs/alternatives/index.md index f860511d..5badf78e 100644 --- a/docs/alternatives/index.md +++ b/docs/alternatives/index.md @@ -201,7 +201,12 @@ These costs can bring significant benefits, but we still want them to be as smal Very slow, but can be greatly improved by removing I/O support and most units - Possibly "best", but will need to assess all libraries on the same code + + + diff --git a/docs/install.md b/docs/install.md index 59833520..d14fe1ad 100644 --- a/docs/install.md +++ b/docs/install.md @@ -120,7 +120,7 @@ to your `deps` attribute, and include the appropriate files. | Dependency | Headers provided | Notes | |------------|------------------|-------| -| `@au//au` | `"au/au.hh"`
`"au/units/*.hh"` | Core library functionality. See [all available units](https://github.com/aurora-opensource/au/tree/main/au/units) | +| `@au//au` | `"au/au.hh"`
`"au/fwd.hh"`
`"au/units/*.hh"`
`"au/units/*_fwd.hh"` | Core library functionality. See [all available units](https://github.com/aurora-opensource/au/tree/main/au/units) | | `@au//au:io` | `"au/io.hh"` | `operator<<` support | | `@au//au:testing` | `"au/testing.hh"` | Utilities for writing googletest tests
_Note:_ `testonly = True` | @@ -141,7 +141,7 @@ In either case, here are the main targets and include files provided by the Au l | Target | Headers provided | Notes | |--------|------------------|-------| -| `Au::au` | `"au/au.hh"`
`"au/io.hh"`
`"au/units/*.hh"` | Core library functionality. See [all available units](https://github.com/aurora-opensource/au/tree/main/au/units) | +| `Au::au` | `"au/au.hh"`
`"au/fwd.hh"`
`"au/io.hh"`
`"au/units/*.hh"`
`"au/units/*_fwd.hh"` | Core library functionality. See [all available units](https://github.com/aurora-opensource/au/tree/main/au/units) | | `Au::testing` | `"au/testing.hh"` | Utilities for writing googletest tests | !!! note