documentationjs/documentation-schema

A standard schema for JSDoc comments

documentation-schema's Issues

Add a license file

It is probably not very useful per se given the nature of this repo's contents, but it's nice to be explicit anyway.

Mission

Prior art: https://github.com/gossi/docspec

• Document documentation JSON object format documentationjs/documentation#18
• "Standardize" this - gutcheck its quality
• Split generation & formatting of this object format
• Generate api-json out of doc tools for python and c++

Add errors property?

Should the errors property be part of the schema?

Add path property?

Should a path property, containing a parsed representation of the membership path, be part of the schema?

Add tags property?

Should a tags property, containing raw tag information, be part of the schema?

Standardize Location type

Standardize all contextual information related to line numbers / columns.

Currently documentationjs uses a mix of conventions:

• loc property
• commentLineNumber
• tag.lineNumber

Replace all of these with the unist Location and Position interfaces.