🎉 Features
- Tutorials with JSDoc-like configuration (#109)
- Experimental support for custom stylesheets (#114)
- Add proper support for ES5 classes, declaring with prototype-assigned functions
- Resolve @classdesc tag correctly, auto-generate constructors when not documented
/**
* This constructor should only be used for custom contexts.
*
* @classdesc
* {@link ExampleFactory} can be used to build examples.
*
* ```js
* // TODO: Make the API interesting
* ExampleFactory.getInstance()
* .build()
* ```
*
* @param {ExampleContext}[context=null] - A custom context for the factory.
* @class
*/
export function ExampleFactory(context= null) {
}
/**
* Get the context of this factory.
*
* @return {ExampleContext}
*/
ExampleFactory.prototype.getContext = function() {
return null;
}
/**
* Build the road.
*/
ExampleFactory.prototype.build = function() {
}
/**
* Gets a lazily-initialized, shared singleton instance of {@link ExampleFactory}.
*
* @returns {ExampleFactory}
*/
ExampleFactory.getInstance = function () {
if (!ExampleFactory.__instance) {
ExampleFactory.__instance = new ExampleFactory();
}
return ExampleFactory.__instance;
}🗞️ Bug fixes
- Fix nested properties not being resolved correctly. The following should work now:
/**
* @property options
* @property options.flag - A flag.
*/
class C {}