dtc/libfdt
David Gibson 4132ac08ba libfdt: Document most remaining functions
Largely an experiment using an AI assistant.  Used Claude to generate
documentation comments for most of the functions in libfdt.h which
currently lack them.  Then hand reviewed and edited.

Or, as Claude describes it:

Add detailed documentation comments for core libfdt functions including:
- Low-level functions (fdt_offset_ptr, fdt_next_tag, fdt_check_full)
- Sequential write functions (fdt_resize, fdt_add_reservemap_entry,
  fdt_finish_reservemap, fdt_begin_node, fdt_property, fdt_end_node, fdt_finish)
- Read-write functions (fdt_create_empty_tree, fdt_open_into, fdt_pack)
- Error handling (fdt_strerror)

Documentation includes parameter descriptions, return value meanings,
and usage notes for proper API usage.

Generated-by: Claude 1.0.64 (claude-sonnet-4@20250514)
Reviewed-by: David Gibson <david@gibson.dropbear.id.au>

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2025-08-01 11:34:18 +10:00
..
.gitignore Link tools and tests against libfdt shared library 2019-03-29 17:20:16 +11:00
fdt.c libfdt_internal: fdt_find_string_len_() 2024-12-06 16:42:25 +11:00
fdt.h Use __ASSEMBLER__ instead of __ASSEMBLY__ 2025-03-14 13:51:31 +11:00
fdt_addresses.c libfdt: fix an incorrect integer promotion 2021-11-17 12:22:53 +11:00
fdt_check.c libfdt: Don't mask fdt_get_name() returned error 2022-07-30 13:52:33 +10:00
fdt_empty_tree.c libfdt: Replace GPL/BSD boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
fdt_overlay.c libfdt: Remove fdt parameter from overlay_fixup_one_phandle 2024-11-25 12:21:00 +11:00
fdt_ro.c libfdt: fdt_path_offset_namelen: Reject empty path 2023-10-11 11:37:24 +11:00
fdt_rw.c libfdt: Add fdt_setprop_namelen() 2024-12-06 16:42:25 +11:00
fdt_strerror.c libfdt: Add ALIGNMENT error string 2021-08-02 12:21:53 +10:00
fdt_sw.c Set last_comp_version correctly in new dtb and fix potential version issues in fdt_open_into 2021-01-04 12:26:37 +11:00
fdt_wip.c libfdt: libfdt_wip: Fix comparison warning 2020-10-02 10:30:07 +10:00
libfdt.h libfdt: Document most remaining functions 2025-08-01 11:34:18 +10:00
libfdt_env.h libfdt: Replace GPL/BSD boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
libfdt_internal.h Fix some typos 2025-03-14 13:50:32 +11:00
Makefile.libfdt libfdt: rename libfdt-X.Y.Z.so to libfdt.so.X.Y.Z 2023-08-06 14:53:29 +10:00
meson.build meson: use override_find_program/override_dependency 2025-06-12 15:55:00 +10:00
sbom.cdx.json libfdt: Move the SBOM authors section 2024-11-20 16:16:57 +11:00
TODO libfdt: Document most remaining functions 2025-08-01 11:34:18 +10:00
version.lds libfdt: Add fdt_setprop_namelen() 2024-12-06 16:42:25 +11:00