Merged
Conversation
96b168a to
3de9796
Compare
This allows better control of formatting of the output. For example, it allows to output an unordered list instead of a description list. By default it expands the first argument ($0) as is, basically making the macro disappear, to keep backwards compatibility.
The second parameter ($1) of the DDOC_HEADER_ANCHOR macro expands to the fully qualified name of the current symbol without the package and module prefix. That is, for a module level symbol it's the name of a symbol. For a nested symbol, like a method in a class, it's the symbol name prefixed with the class name. The third parameter ($2) expands to just the name of the current symbol. The DDOC_MEMBER_HEADER wraps DDOC_HEADER_ANCHOR to allow a sensible output format. The DDOC_MEMBER_HEADER is wrapped in the DDOC_MEMBER macro. By default these two macros expand to nothing, to keep backwards compatibility.
3de9796 to
cab2c33
Compare
Current coverage is 87.38% (diff: 100%)@@ master #6170 diff @@
==========================================
Files 104 104
Lines 57418 57396 -22
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
- Hits 50178 50154 -24
- Misses 7240 7242 +2
Partials 0 0
|
Contributor
Author
|
@andralex ping |
Member
|
Nice work, thanks! |
Member
|
Auto-merge toggled on |
Contributor
Author
|
@andralex I need to update the documentation and do a minor tweak for the theme that is used in dlang.org. Where do I find that, and are there any other docs/themes that need to be updated? |
Member
|
I guess all of those should be in the https://github.com/dlang/dlang.org repo? The pertinent ddoc files are *.ddoc. For the site, https://github.com/dlang/dlang.org/blob/master/posix.mak shows how they're used: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR is split into two separate commits, where the later ones depend on the former ones. The commit messages describe pretty well what they do and the intention. I've copied them here for convince:
Ddoc: wrap each symbol in the
DDOC_MEMBERmacroThis allows better control of formatting of the output. For example,
it allows to output an unordered list instead of a description list.
By default it expands the first argument (
$0) as is, basically makingthe macro disappear, to keep backwards compatibility.
Ddoc: add new macros:
DDOC_MEMBER_HEADERandDDOC_HEADER_ANCHORThe second parameter (
$1) of theDDOC_HEADER_ANCHORmacro expands tothe fully qualified name of the current symbol without the package and
module prefix. That is, for a module level symbol it's the name of a
symbol. For a nested symbol, like a method in a class, it's the symbol
name prefixed with the class name. The third parameter (
$2) expands tojust the name of the current symbol.
The
DDOC_MEMBER_HEADERwrapsDDOC_HEADER_ANCHORto allow a sensibleoutput format. The
DDOC_MEMBER_HEADERis wrapped in theDDOC_MEMBERmacro.
By default these two macros expand to nothing, to keep backwards
compatibility.