Skip to content

Navigation Menu

Explore
By company size
By use case
By industry
View all solutions
Topics
- AI
- DevOps
- Security
- Software Development
- View all
Explore
- GitHub Sponsors
  Fund open source developers
- The ReadME Project
  GitHub community articles
Repositories
- Enterprise platform
  AI-powered developer platform
Available add-ons
Pricing

Search code, repositories, users, issues, pull requests...

Search

Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation.

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Dismiss alert

WordPress / gutenberg Public

Notifications You must be signed in to change notification settings
Fork 4.3k
Star 10.8k

Code
Issues 5k+
Pull requests 1.6k
Discussions
Actions
Projects 9
Security
Insights

Additional navigation options

Code
Issues
Pull requests
Discussions
Actions
Projects
Security
Insights

New package to auto-generate public API documentation#13329

Merged

oandregal merged 213 commits intomasterWordPress/gutenberg:masterfrom try/api-docsWordPress/gutenberg:try/api-docsCopy head branch name to clipboard

Mar 1, 2019

+8,511-34

Conversation Commits213 (213)Checks Files changed

Commits

Commits on Mar 1, 2019

First, find export declarations
oandregal
committed
Second, parse JSDoc
oandregal
committed
Third, create markdown files with exports and JDoc descriptions.
oandregal
committed
Refactor and prevent against no JSDoc
oandregal
committed
Move script to own package
oandregal
committed
Split api into cli, engine, and formatter
oandregal
committed
Add initial tests
oandregal
committed
Test named export (const)
oandregal
committed
Add test for default named functions
oandregal
committed
Add support for default export of anonymous functions
oandregal
committed
Better phrasing for test
oandregal
committed
Add support for default exports (identifiers)
oandregal
committed
Add support for named exports of a single identifier
oandregal
committed
Add test for many exports at once
oandregal
committed
Tweak text and reorder tests
oandregal
committed
Teach engine to take JSDoc from identifier declaration
oandregal
committed
Cover undocumented exports
oandregal
committed
Be more explicit about what is a test file
oandregal
committed
Add more test to cover potential regressions
oandregal
committed
Expose script as npm script
oandregal
committed
CLI: manage errors
oandregal
committed
Refactor to pave the way to next step
oandregal
committed
Refactor to prepare next step
oandregal
committed
Refactor to prepare next step
oandregal
committed
Add helper functions
oandregal
committed
Add mechanism to query upper layers for dependency code
oandregal
committed
Engine can lookup JSDoc in dependency file
oandregal
committed
Formatter - adapt a new engine API
oandregal
committed
Add test for looking up JSDoc in dependency
oandregal
committed
CLI: adapt to new engine API
oandregal
committed
Engine: enable JSX support
oandregal
committed
Evaluate how much coverage do we have already
oandregal
committed
Remove unused file
oandregal
committed
Add test for multiple named exports
oandregal
committed
Add more info for debugging purposes
oandregal
committed
Add tests for get name of named function and variable
oandregal
committed
Add support and test for parsing classes
oandregal
committed
Add test for single identifier
oandregal
committed
Add test for multiple named identifiers
oandregal
committed
Add tests for default export of functions (anonymous and named)
oandregal
committed
Add tests for default export of variables
oandregal
committed
Add tests for default export of classes
oandregal
committed
Add tests for default export of identifier
oandregal
committed
Add test for export redirects (* and default)
oandregal
committed
Placeholder to implement ExportAllDeclaration
oandregal
committed
Update engine and tests
oandregal
committed
Adapt get-name-declaration to return an array
oandregal
committed
Implement retrieval of multiple specifiers
oandregal
committed
Reorganize test to prepare next steps
oandregal
committed
Refactor default and namespace exports
oandregal
committed
Flatten importName and localName
oandregal
committed
get-name-declaration: refactor to return export entry list
oandregal
committed
get-name-declaration renamed to get-export-entries
oandregal
committed
Reorder dependency statements
oandregal
committed
Remove uncessary test
oandregal
committed
Refactor get IR and add tests for default exports
oandregal
committed
Rename file
oandregal
committed
Flatten export entries returned by IR
oandregal
committed
Fix engine tests
oandregal
committed
Update tests for IR
oandregal
committed
Fix tests
oandregal
committed
getExportEntries: retrieve module from export statement
oandregal
committed
getIR: fix dependency lookup
oandregal
committed
Protect against no code provided
oandregal
committed
Better test names
oandregal
committed
Implement exported names
oandregal
committed
Fix exported names
oandregal
committed
Update coverage
oandregal
committed
Add test for namespace export
oandregal
committed
Update coverage.md
oandregal
committed
Fix export entries test
oandregal
committed
IR: add support for namespace exports
oandregal
committed
Fix method call
oandregal
committed
Extract constants for better encapsulation
oandregal
committed
Update coverage
oandregal
committed
Add test for named and default exports
oandregal
committed
Add JSDoc lookup for named inline nodes such as:
oandregal
committed
Update coverage
oandregal
committed
Better test organization
oandregal
committed
Implement JSDoc lookup in default identifier from import
oandregal
committed
Better test organization
oandregal
committed
getExportEntries: test for _import default from module_
oandregal
committed
Add support for JSDoc lookup of imported identifiers
oandregal
committed
Update coverage
oandregal
committed
Install docgen package
oandregal
committed
Improve CLI
oandregal
committed
Add tests for retrieving JSDoc of destructured objects
oandregal
committed
Add support for JSDoc lookup of destructured objects
oandregal
committed
Adapt tests to new engine API
oandregal
committed
Fix JSDoc lookup for named export
oandregal
committed
Update coverage
oandregal
committed
Remove docgen from package.json
oandregal
committed
Better README
oandregal
committed
Update coverage
oandregal
committed
Ignore comments in namespace exports
oandregal
committed
Update coverage
oandregal
committed
CLI generates output by adding suffixes to input
oandregal
committed
Add test for export imported namespaces
oandregal
committed
Add test for export imported namespaces
oandregal
committed
Add named-import-namespace AST
oandregal
committed
Extract method
oandregal
committed
IR - add breaking test
oandregal
committed
Fix bug on export redirection
oandregal
committed
Add support for import namespace
oandregal
committed
Update coverage
oandregal
committed
Respect the dependency extension if any
oandregal
committed
Update coverage
oandregal
committed
Add test for undocumented declaration (no comments)
oandregal
committed
Add test for undocumented declaration (// comment)
oandregal
committed
Update README
oandregal
committed
Add a debug mode
oandregal
committed
Update coverage
oandregal
committed
Better example
oandregal
committed
Better README.md
oandregal
committed
Add params tags to IR and formatter
oandregal
committed
Formatter: show return tag output
oandregal
committed
Adapt engine tests to new API
oandregal
committed
Adapt formatter tests to new API
oandregal
committed
Adapt IR tests to new API
oandregal
committed
Update fixtures and test data to uncover some bug
oandregal
committed
Reorder tests
oandregal
committed
Fix bug on retrieving JSDoc from module dep
oandregal
committed
Markdown: clean spaces in descriptions
oandregal
committed
Add support for nullable types
oandregal
committed
Extract getParamType and add tests
oandregal
committed
getParamType: add support for RestType
oandregal
committed
getParamType: add support for unions
oandregal
committed
Markdown tweaks: better formatting, adding output type
oandregal
committed
Markdown: sort output by symbol name
oandregal
committed
Markdown: improve spacing
oandregal
committed
Use | symbols for type unions
oandregal
committed
Use ... symbols for rest tipes
oandregal
committed
Markdown: update to consider uniont and rest types
oandregal
committed
getParamType: add support for nullable params
oandregal
committed
Markdown: add example tag to output
oandregal
committed
Update tests to API changes
oandregal
committed
Prevent bug when paragraph is null
oandregal
committed
Update coverage
oandregal
committed
Update coverage
oandregal
committed
Add support for see tag
oandregal
committed
Add support for link tag
oandregal
committed
Allow having several examples for one symbol
oandregal
committed
Less space between types: (object|string)
oandregal
committed
Keep description format as it is
oandregal
committed
Add support for type tag
oandregal
committed
Rename get-param-type-as-string to get-type-as-string
oandregal
committed
Adapt test to API changes
oandregal
committed
Add support for * type
oandregal
committed
Add support for type applications
oandregal
committed
Add support for NullLiteral
oandregal
committed
Add support for UndefinedLiteral and optional parameters
oandregal
committed
Add support for default values
oandregal
committed
Add support for deprecated tag
oandregal
committed
params and return tags are no longer special
oandregal
committed
Refactor formatter to compact code
oandregal
committed
Update coverage
oandregal
committed
Add line numbers (start, end) to export tokens
oandregal
committed
Adapt tests to new API
oandregal
committed
Add line number to intermediate representation
oandregal
committed
Fix line numbers for namespace export
oandregal
committed
Remove duplicated tests
oandregal
committed
Better test names
oandregal
committed
Add path to intermediate representation
oandregal
committed
Adapt tests to API changes
oandregal
committed
Add path and line numbers to markdown output
oandregal
committed
Add TODO file
oandregal
committed
Use optionator to process CLI options
oandregal
committed
Allow to specify a markdown output file
oandregal
committed
Allow to pass a formatter
oandregal
committed
Document new added options
oandregal
committed
CLI: add ability to ignore symbols by name
oandregal
committed
Update README
oandregal
committed
CLI: support append to existing Markdown file
oandregal
committed
Make linter happy
oandregal
committed
Add package to manifest
oandregal
committed
Update as per new package recommendations
oandregal
committed
Update package name
oandregal
committed
Add docgen as a dev dependency
oandregal
committed
Add wordpress keyword to package.json
oandregal
committed
Mark as a bash command
oandregal
committed
CLI: allow for walking parent directories
oandregal
committed
Add tests for tags
oandregal
committed
Adapt formatter test to API
oandregal
committed
Move IR tests related to JSDoc to its own tester
oandregal
committed
get-jsdoc-from-token returns a human-readable type
oandregal
committed
Implement a token-based injection for Markdown
oandregal
committed
Add embed JSDoc
oandregal
committed
Formatter: let heading index be configurable
oandregal
committed
Use proper heading when embedding content within token
oandregal
committed
Move default markdown code to own folder
oandregal
committed
Migrate engine tests to jest
oandregal
committed
Reorganize fixtures
oandregal
committed
Migrate export tests to jest
oandregal
committed
Migrate getTypeFromJSDoc tests to jest
oandregal
committed
Migrate getJSDocFromToken tests to jest
oandregal
committed
Migrate getIntermediateRepresentation tests to jest
oandregal
committed
Migrate Markdown formatter tests to jest
oandregal
committed
Extract bin/cli utility
oandregal
committed
Uninstall no longer needed dev deps
oandregal
committed
Fix docgen dependencies
oandregal
committed
Add command to generate docs
oandregal
committed
Update docs
oandregal
committed
Update README
oandregal
committed
Add --use-token option
oandregal
committed
Extract constants
oandregal
committed
Update README
oandregal
committed
Make formatter-markdown test be deterministic
oandregal
committed
Make formatter-markdown test be deterministic
oandregal
committed
Update packages/docgen/README.md

authored and
oandregal
committed
Update packages/docgen/README.md

authored and
oandregal
committed
Update packages/docgen/README.md

authored and
oandregal
committed
Add command in the examples
oandregal
committed
Update package-lock using the latest npm
oandregal
committed

Footer

© 2025 GitHub, Inc.

Footer navigation

Terms
Privacy
Security
Status
Docs
Contact

You can’t perform that action at this time.