WordPress.org
Get WordPress

Make WordPress Core

Opened 12 years ago

Closed 11 years ago

#24748 closed defect (bug) (invalid)

Better documentation in core JS files

Reported by: drewapicture's profile DrewAPicture Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: javascript, docs Cc:

Description

As noted in #24723, core has never really been very vigilant in adding file headers or doc blocks to JS files, something I think we can vastly improve on in 3.7.

Creating this as a starter ticket for members the Seattle Docs Meetup and the Docs/Support Team as a work in progress.

Change History (6)

#1 @wonderboymusic
12 years ago

  • Milestone changed from Future Release to 3.7

these are all marked 3.7-early

#2 @carldanley
12 years ago

@adamsilverstein and I have plans to go through individual JS files and clean things up. I know I planned on doc fixes for each file as the current commenting structure is terrible. For standard purposes, I think we should stick with JSDoc formats. I'm def. interested in making this happen just let me know where I can help.

#3 @DrewAPicture
12 years ago

  • Keywords 3.7-early removed
  • Milestone changed from 3.7 to Future Release

Let's make this release-agnostic.

#4 @nacin
11 years ago

  • Component changed from Inline Docs to General
  • Focuses javascript docs added

This ticket was mentioned in IRC in #wordpress-dev by nacin. ​View the logs.
11 years ago

#6 @DrewAPicture
11 years ago

  • Keywords needs-patch removed
  • Milestone Future Release deleted
  • Resolution set to invalid
  • Status changed from new to closed

Closing in favor of individual tickets.

Note: See TracTickets for help on using tickets.