Inline Docs Chat Agenda, Dec. 3


Here is the loose agenda for today’s inline docs chat in the #docs channel on Slack at 20:00 UTC

  1. Private/internal functionality
    We need to come up with a plan and frame of reference for how private/internal functionality should be treated in terms of what’s parsed and what’s not.
  2. Guidelines for `see` tags
    In some core DocBlocks, multiple functions are listed. Is that allowed/supported? Do we have adequate coverage for inline `see` tags?
  3. JavaScript Docs Standard
    Outstanding discussion topics:

    • List of text editors/IDEs with bundles/extensions for auto-creating JSDoc blocks (@ericlewis) (Sublime w/DocBlockr)
    • List of `@` tags we don’t use in core (Kim to write explanations why)
    • Consistency with the PHP Doc Standard (sections/format)

#inline-docs