Add API synopsis titles and cross references #562
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a title to each
[source]
block that is a synopsis. The title uses[apidef]
if the title is a unique name for a SYCL identifier,otherwise it uses
[apititle]
.Also add an extension which creates automatic cross references to the
[apidef]
synopses. In order to make a cross reference, use theAsciidoc role
[api]
. This is styled like[code]
but also creates across reference. For example,
[api]#foo#
creates a cross reference tothe synopsis whose title is
[apidef]#foo#
.Replace some uses of
[code]
with[api]
in the sections defining themath builtins.