Bug Tracker

Modify

Ticket #791 (closed enhancement: invalid)

Opened 6 years ago

Last modified 3 years ago

Cross-reference API documentation

Reported by: joern Owned by:
Priority: major Milestone:
Component: docs Version:
Keywords: Cc:
Blocking: Blocked by:

Description (last modified by john) (diff)

A good API documentations needs cross-reference. A possible format for the inline documentation would use the @see format:

/**
 * ...
 * @see otherMethod(Arguments)
 */

To implement this, we have to define a format that is easy to write and not ambigous. So far all methods can be distinguished by their argument types, for example, the various $ implementations share the same name with different arguments:

@see $(String)
@see $(String, Element|jQuery)
@see $(Element|Array<Element>)
@see $(Function)

Those identifies must be converted to the hash identifies that the Mediawiki generates:

#.24.28_html_.29
#.24.28_expr.2C_context_.29
#.24.28_fn_.29
#.24.28_elems_.29

Currently the wiki uses the argument names to identify methods, I'd prefer that to be changed to argument types.

It has to be considered to mix both, though I see the drawback here of increased effort to write and maintain the @see tags, while it may be easier to understand for the reader what is expected.

Change History

comment:1 Changed 3 years ago by john

  • need set to Review
  • Status changed from new to closed
  • Resolution set to invalid
  • Description modified (diff)

We don't use inline JSDoc any more.

Please follow the  bug reporting guidlines and use  jsFiddle when providing test cases and demonstrations instead of pasting the code in the ticket.

View

Add a comment

Modify Ticket

Action
as closed
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.