apidoc/apidoc-core

Order of elements should be preserved when using @apiUse

jharting opened this issue · 0 comments

I often combine explicitly defined parameters (@apiParam) and return values (@apiSuccess) with those that come from a template (@apiUse). When doing so, it would be nice if the order of elements was preserved. However, what happens is that all elements included using @apiUse end up last. Here's an example:

/**
 * @apiDefine bar
 * @apiParam {String} bar bar
 */

/**
 * ...
 * @apiParam {String} foo foo
 * @apiUse bar
 * @apiParam {String} baz baz
 */

The expected result is params listed in the following order: foo, bar, baz. Unfortunately, that's not what happens as this screenshot illustrates:

apidoc2

Looking at the code this seems pretty difficult to implement due to the way @apiUse is currently implemented. Any thoughts?