better-docs icon indicating copy to clipboard operation
better-docs copied to clipboard

@lifecycle, template options, react native @component

Open sonyboy232 opened this issue 4 years ago • 1 comments

Added several new template options and a 'lifecycle' plugin to make the generated documentation much more manageable

  • added isReactNative template setting
    • Doesn't use the entry.js file created in bundler.js
  • added linkTagToNewTab template setting
    • Automatically uses target="_new" on external URL's in the {@link} tag
  • added useNestedCategories template setting:
    • Creates a @category -> @subcategory -> type hierarchy to the left navigation
  • added usePropertyFolding template setting
    • Adds ability to fold object type properties in their tables
  • added useNavFolding template setting
    • Adds the ability to fold the left navigation
    • fold state persists across page loads
  • added subsectionsInSideNav template setting
    • An array of subsection types that should be added to the right navigation
    • augments,requires,classes,interfaces,mixins,namespaces
  • added includeTodoPage template setting
    • Boolean to determine if a "To Do" list page should be generated along with the documentation
    • generated list will include all @todo tags defined anywhere in the system and are categorized by the file in which they appear.
    • Link to the to "to do" list is included in the right navigation
  • added the lifecycle plugin which implements @lifecycle and @renders
    • adds a 'lifecycle' tag above the method
    • separates the lifecycles into their own category on the right nav
    • @renders just adds a 'renders' tag above the method
  • added table plugin
    • @table tag
    • logically separate typedefs into a 'Tables' section
  • added inheritable plugin
    • @inheritDesc, @inheritSummary, @inheritParams
    • Allow for ability to inherit parts of parent documentation from within a child class
  • update app.js to make sure that URL hashes always jump to the correct spot on page load
  • update properties.tmpl and property.tmpl so that properties will nest to infinity
  • update proptypes.tmpl so that the property type will link to the appropriate place
  • add new features and options to README

sonyboy232 avatar Oct 30 '20 20:10 sonyboy232

What I noticed is that this fails if I don't pass any template options with this error:

FATAL: Unable to load template: Cannot read property 'linkTagToNewTab' of undefined

zarcode avatar Feb 03 '21 12:02 zarcode