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
Insert item at index index. Moves list[index .. list.len] to higher indices to make room. If index is equal to the length of the list this operation is equivalent to append. This operation is O(N). Invalidates element pointers if additional memory is needed. Invalidates pre-existing pointers to elements at and after index. Asserts that the index is in bounds or equal to the length.
Insert
itemat indexindex. Moveslist[index .. list.len]to higher indices to make room. Ifindexis equal to the length of the list this operation is equivalent to append. This operation is O(N). Invalidates element pointers if additional memory is needed. Invalidates pre-existing pointers to elements at and afterindex. Asserts that the index is in bounds or equal to the length.