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 standard library. Public Function
extension
Public Function
std.fs.path.extension
pubfnextension(path: []constu8) []constu8
Searches for a file extension separated by a . and returns the string after that .. Files that end or start with . and have no other . in their name are considered to have no extension, in which case this returns "". Examples:
"main.zig" ⇒ ".zig"
"src/main.zig" ⇒ ".zig"
".gitignore" ⇒ ""
".image.png" ⇒ ".png"
"keep." ⇒ "."
"src.keep.me" ⇒ ".me"
"/src/keep.me" ⇒ ".me"
"/src/keep.me/" ⇒ ".me" The returned slice is guaranteed to have its pointer within the start and end pointer address range of path, even if it is length zero.
Searches for a file extension separated by a
.and returns the string after that.. Files that end or start with.and have no other.in their name are considered to have no extension, in which case this returns "". Examples:"main.zig"⇒".zig""src/main.zig"⇒".zig"".gitignore"⇒""".image.png"⇒".png""keep."⇒".""src.keep.me"⇒".me""/src/keep.me"⇒".me""/src/keep.me/"⇒".me"The returned slice is guaranteed to have its pointer within the start and end pointer address range ofpath, even if it is length zero.