This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.
usage
objdump.usage
constusage =
\\Usage: zig objdump [options] file\\\\Options:\\ -h, --help Print this help and exit\\ --all-headers Alias for --file-headers --linker-member=2 --member-headers --section-headers --relocs --symbols\\ --exports[=sort] Display exported symbols. \\ In the case of COFF import libraries, displays the symbol list and import headers.\\ Specify =sort to optionally sort the import headers by symbol name.\\ --file-headers Display file-format specific headers\\ --imports Display imported symbols\\ --linker-member[=1|2|longnames] (Coff) Display contents of the specified archive linker member (default 2)\\ --member-headers Display archive member headers\\ --elements=[e1],[e2],-[e3],... Select which formatting elements are displayed. Intended for snapshot testing.\\ file-type File type summary\\ header-name Name that precedes a header block \\ member-path Display full member paths. If removed, only basenames will be used.\\ newlines Newlines between output sections\\ table-header Table headers with column names\\ all (default) All of the above\\ --only-member=[name] Only consider archive members names that contain [name]. Can be specified multiple times.\\ --only-section=[name] Only consider section names that contain [name]. Can be specified multiple times.\\ --only-symbol=[name] Only consider symbol names that contain [name]. Can be specified multiple times.\\ --redact=[kind] Redact the specified field kind. Intended for snapshot testing.\\ rva Relative virtual addresses\\ va Virtual addresses and file offsets\\ ord Symbol ordinals / hints\\ size Sizes and lengths\\ all All of the above\\ --relocs Display relocations\\ -s, --snapshot Alias for --redact=all --elements=-all\\ --section-headers Display section headers\\ --strings Display string tables\\ --symbols Display symbol tables\\ --tls Display TLS information
constusage =
\\Usage: zig objdump [options] file\\\\Options:\\ -h, --help Print this help and exit\\ --all-headers Alias for --file-headers --linker-member=2 --member-headers --section-headers --relocs --symbols\\ --exports[=sort] Display exported symbols. \\ In the case of COFF import libraries, displays the symbol list and import headers.\\ Specify =sort to optionally sort the import headers by symbol name.\\ --file-headers Display file-format specific headers\\ --imports Display imported symbols\\ --linker-member[=1|2|longnames] (Coff) Display contents of the specified archive linker member (default 2)\\ --member-headers Display archive member headers\\ --elements=[e1],[e2],-[e3],... Select which formatting elements are displayed. Intended for snapshot testing.\\ file-type File type summary\\ header-name Name that precedes a header block \\ member-path Display full member paths. If removed, only basenames will be used.\\ newlines Newlines between output sections\\ table-header Table headers with column names\\ all (default) All of the above\\ --only-member=[name] Only consider archive members names that contain [name]. Can be specified multiple times.\\ --only-section=[name] Only consider section names that contain [name]. Can be specified multiple times.\\ --only-symbol=[name] Only consider symbol names that contain [name]. Can be specified multiple times.\\ --redact=[kind] Redact the specified field kind. Intended for snapshot testing.\\ rva Relative virtual addresses\\ va Virtual addresses and file offsets\\ ord Symbol ordinals / hints\\ size Sizes and lengths\\ all All of the above\\ --relocs Display relocations\\ -s, --snapshot Alias for --redact=all --elements=-all\\ --section-headers Display section headers\\ --strings Display string tables\\ --symbols Display symbol tables\\ --tls Display TLS information
