Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tools: parse documentation metadata (take 2) #6495

Closed
wants to merge 6 commits into from
Closed

tools: parse documentation metadata (take 2) #6495

wants to merge 6 commits into from

Commits on May 4, 2016

  1. tools: add mock-y js-yaml dependency to doctool 

    Add a hack js-yaml module to the doctool dependencies that simply
loads the one that’s included with eslint.

This helps avoiding to check in the whole dependency tree into
the core repo.
    @addaleax
    addaleax committed May 4, 2016
    Configuration menu
    Copy the full SHA
    aaff1b4 View commit details
    Browse the repository at this point in the history

  2. tools: parse documentation metadata 

    This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: nodejs#3713
Ref: nodejs#6470
    @tflanagan @addaleax
    tflanagan authored and addaleax committed May 4, 2016
    Configuration menu
    Copy the full SHA
    7ee6bd1 View commit details
    Browse the repository at this point in the history

  3. tools: check for yaml when generating json output 

    The HTML backend of the doctool checked comments for being
tagged as YAML before treating them as such, so the JSON
backend should do that, too.
    @addaleax
    addaleax committed May 4, 2016
    Configuration menu
    Copy the full SHA
    fc1661f View commit details
    Browse the repository at this point in the history

  4. test,tools: test yaml parsing of doctool 

    Add checks that make sure the doctool parses metadata correctly.
    @addaleax
    addaleax committed May 4, 2016
    Configuration menu
    Copy the full SHA
    f52f76b View commit details
    Browse the repository at this point in the history

  5. tools: allow multiple added: version entries 

    Allow multiple `added:` version entries, since semver-minors
can trickle down to previous major versions, and thus
features may have been added in multiple versions.

Also include `deprecated:` entries and apply the same logic
to them for consistency.

Stylize the added HTML as `Added in:` and `Deprecated since:`.
    @addaleax
    addaleax committed May 4, 2016
    Configuration menu
    Copy the full SHA
    8bd24b2 View commit details
    Browse the repository at this point in the history

  6. doc: add added: information for buffer 

    Add `added:` and `deprecated:` entries to buffer.md.
These are incomplete (particularly for some of the ancient features),
but correct to the best of my knowledge. This serves as a
demonstration of how the `added:`/`deprecated:` metadata may be
implemented in 'real' docs.
    @addaleax
    addaleax committed May 4, 2016
    Configuration menu
    Copy the full SHA
    b5a633c View commit details
    Browse the repository at this point in the history