zu-c holds the reference item - #660
Merged
Merged
Conversation
tamnd/zu-c#10 generates the reference from include/zu.hpp and publishes it with the release rather than keeping a copy in the tree. The item is held on the check rather than on the output. Doxygen exits 0, with no warnings and no pages, on a header it extracted nothing from, so a gate that is only "the generator was quiet" passes over an empty reference. It did, for a day: an include guard left in PREDEFINED made the preprocessor drop the whole header. The client's check reads the header a second time and by different means and fails when the types it declares are not in what came out. Practice goes 67 to 78 over a denominator of 90, which is the tier's 100 less the api-map and perf weights zu-c does not owe. install and stability are what is left.
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
1 participant
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.
tamnd/zu-c#10 generates the API reference from
include/zu.hppand publishes it with the release rather than keeping a directory of generated HTML in the tree.Most of the work was in the header. Doxygen only reads
/**and/*!, and every comment inzu.hppwas written as/*, so the first generated reference had 355 undocumented members in it. Where the header documents an overload set once, it still does:DISTRIBUTE_GROUP_DOChands the first comment in a group to every member of it, which is what keeps thetry_half of each class carrying no prose that could drift from the throwing half it mirrors.The item is held on the check rather than on the output. Doxygen exits 0, with no warnings and no pages, on a header it extracted nothing from, and
WARN_IF_UNDOCUMENTEDcannot fire when there is nothing there to be undocumented. That is not hypothetical: aZU_HPPleft inPREDEFINEDdefined the header's own include guard, the preprocessor dropped the entire file, and the run was green and empty. So the client's check reads the header a second time and by different means, greps the types it declares at namespace scope, and fails when the reference does not have them. Both failures are exercised in the client's own suite, the empty one and the one bare member.Practice goes 67 to 78, over a denominator of 90, which is the tier's 100 less the
api-mapandperfweights zu-c does not owe.installandstabilityare what is left on the card.xtask clientsstill reports 4 of 5 tier 1 clients at their tier's practice threshold, which is correct: zu-c is the fifth and it is not there yet.