-
Notifications
You must be signed in to change notification settings - Fork 20
Open
Description
Multiple documentation comments within my codebase have their code examples become garbled.
Eg, this doc comment
/**
Gets whether 2 memory ranges are overlapping.
Params:
a = Start address of first range.
aLength = Length of first range, in bytes.
b = Start address of second range.
bLength = Length of second range, in bytes.
Returns:
$(D true) if range $(D a) and $(D b) overlaps, $(D false) otherwise.
It is assumed that start points at $(D null) and lengths of $(D 0) never
overlap.
Examples:
---
int[] arr1 = [1, 2, 3, 4];
int[] arr2 = arr1[1..$-1];
size_t arr1len = arr1.length*int.sizeof;
size_t arr2len = arr2.length*int.sizeof;
// Test all iterations that are supported.
assert(nu_is_overlapping(arr1.ptr, arr1len, arr2.ptr, arr2len));
assert(!nu_is_overlapping(arr1.ptr, arr1len, arr2.ptr, 0));
assert(!nu_is_overlapping(arr1.ptr, 0, arr2.ptr, arr2len));
assert(!nu_is_overlapping(null, arr1len, arr2.ptr, arr2len));
assert(!nu_is_overlapping(arr1.ptr, arr1len, null, arr2len));
---
*/
Is rendered as follows.
Metadata
Metadata
Assignees
Labels
No labels