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.

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

tools: Include links to source code in documentation #22405

Closed
wants to merge 9 commits into from

Commits on Aug 26, 2018

  1. tools: Include links to source code in documentation

    Parse soruce code using acorn; extracting exports.  When producing
    documentation, match exports to headers.  When a match is found, add a [src]
    link.
    
    This first commit handles simple exported classes and functions, and does so
    without requiring any changes to the source code or markdown.  Subsequent
    commits will attempt to match more headers, and some of these changes are
    likely to require changes to the source code and/or markdown.
    rubys committed Aug 26, 2018
    Configuration menu
    Copy the full SHA
    eb2731c View commit details
    Browse the repository at this point in the history
  2. address a number of comments

    rubys committed Aug 26, 2018
    Configuration menu
    Copy the full SHA
    55b3158 View commit details
    Browse the repository at this point in the history

Commits on Aug 27, 2018

  1. tools,doc: test for apilinks

    refack authored and rubys committed Aug 27, 2018
    Configuration menu
    Copy the full SHA
    987a3c2 View commit details
    Browse the repository at this point in the history
  2. [squashable] prepare for multiple apilinks tests

    1) Run tests against every file in test/fixtures/apilinks/
    2) Embed expected results in the fixture itself
    rubys committed Aug 27, 2018
    Configuration menu
    Copy the full SHA
    df079ee View commit details
    Browse the repository at this point in the history
  3. [squashable] attempt to address refack's comments

    I think I've addressed everything with the possible exception of the
    K.I.S.S. vs generic tester comment.  See if this is acceptable.
    
    My thoughts are that we are going to end up with dozens of tests, and having a
    master list of expected results across all tests will be error prone.  It is
    my expectation that it will be much easier to maintain individual tests and
    individual expected results.
    
    In the future, we can also parse process.argv to allow the running of
    an individual test.
    rubys committed Aug 27, 2018
    Configuration menu
    Copy the full SHA
    f59f014 View commit details
    Browse the repository at this point in the history
  4. [squashable] appease linter

    rubys committed Aug 27, 2018
    Configuration menu
    Copy the full SHA
    9c697eb View commit details
    Browse the repository at this point in the history

Commits on Aug 28, 2018

  1. Configuration menu
    Copy the full SHA
    99b11c4 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    8c21979 View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2018

  1. Configuration menu
    Copy the full SHA
    242fb3b View commit details
    Browse the repository at this point in the history