mirror of
https://github.com/NixOS/nix.git
synced 2025-11-08 19:46:02 +01:00
doc: Improve libexpr-c docs
- Uses the more explicit `@ingroup` most of the time, to avoid problems with nested groups, and to make group membership more explicit. The division into headers is not great for documentation purposes, so this helps. - More attention for memory management details - Various other improvements to doc comments
This commit is contained in:
parent
1a4ad0706b
commit
5fc0c4f102
6 changed files with 237 additions and 78 deletions
|
|
@ -240,3 +240,9 @@ $ configurePhase
|
|||
$ ninja src/external-api-docs/html
|
||||
$ xdg-open src/external-api-docs/html/index.html
|
||||
```
|
||||
|
||||
If you use direnv, or otherwise want to run `configurePhase` in a transient shell, use:
|
||||
|
||||
```bash
|
||||
nix-shell -A devShells.x86_64-linux.native-clangStdenv --command 'mesonFlags="$mesonFlags -Ddoc-gen=true"; mesonConfigurePhase'
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue