summaryrefslogtreecommitdiff
path: root/libc/utils/docgen
diff options
context:
space:
mode:
authorPrashanth <TheStarOne01@proton.me>2025-01-10 22:57:40 +0530
committerGitHub <noreply@github.com>2025-01-10 09:27:40 -0800
commit0afee850de1ebe9af71bdf727d906fefa78ad68c (patch)
tree5104e2ad8fc72a815ebbfeba1bf14c9b7d75c1ed /libc/utils/docgen
parentdff7ef2353fec9f1006895c0e99bde704296eaa9 (diff)
[libc][docs] Add net/if.h documentation by referring to POSIX standards (#122406)
This pull request introduces the following changes to the project with reference to issue ( #122006 ): 1. **Documentation Update**: - Added a new YAML file `if.yaml` under `net` to document network interface functions and macros. - The `if.yaml` file includes the following functions and macros: - Functions: - `if_freenameindex` - `if_indextoname` - `if_nameindex` - `if_nametoindex` - Macros: - `IF_NAMESIZE` 2. **CMake Configuration Update**: - Updated the `CMakeLists.txt` file to create the necessary directory for the `net` headers. - Included the `net/if` documentation in the Sphinx build configuration. 3. **Index Update**: - Updated the `index.rst` file to include a reference to the newly added `net/if` documentation. **Purpose**: - This pull request adds documentation for network interface functions and macros, ensuring they are included in the project's documentation. - Updates the CMake configuration to support the new documentation. **Testing**: - Verified that the new YAML file is correctly referenced in the `index.rst`. - Ensured that the documentation builds without errors and includes the new network interface documentation. Co-authored-by: Nick Desaulniers <ndesaulniers@google.com>
Diffstat (limited to 'libc/utils/docgen')
-rw-r--r--libc/utils/docgen/net/if.yaml13
1 files changed, 13 insertions, 0 deletions
diff --git a/libc/utils/docgen/net/if.yaml b/libc/utils/docgen/net/if.yaml
new file mode 100644
index 000000000000..085d27b2bb94
--- /dev/null
+++ b/libc/utils/docgen/net/if.yaml
@@ -0,0 +1,13 @@
+functions:
+ if_freenameindex:
+ in-latest-posix: ''
+ if_indextoname:
+ in-latest-posix: ''
+ if_nameindex:
+ in-latest-posix: ''
+ if_nametoindex:
+ in-latest-posix: ''
+
+macros:
+ IF_NAMESIZE:
+ in-latest-posix: '' \ No newline at end of file