Last modified: 2014-07-15 21:29:01 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T53650, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 51650 - VisualEditor: Remove (and stop adding) useless documentation
VisualEditor: Remove (and stop adding) useless documentation
Status: ASSIGNED
Product: VisualEditor
Classification: Unclassified
Technical Debt (Other open bugs)
unspecified
All All
: Normal enhancement
: ---
Assigned To: Editing team bugs – take if you're interested!
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-07-19 01:27 UTC by Krinkle
Modified: 2014-07-15 21:29 UTC (History)
5 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Krinkle 2013-07-19 01:27:51 UTC
/**
 * Creates an ve.Element object.
 *
 * @class
 * @abstract
 *
 * @constructor
 */
ve.Element = function VeElement

These and everything like are useless (not really explaining anything) and annoying (gets you excited to see a line of text only to find out its nothing) and makes the jsduck --nodoc utility unusable since a lot of things without documentation aren't without documentation.

So, henceforth, it is "okay" for a doc block to be just tags with no description on top (or even just /** */ with nothing, which is all jsduck needs to include a property in its index).

I (or someone else) will be ridding these at some point, but lets try and not duplicate them more (I won't take "consistency" as an argument here when creating something that is like something else that has a useless description, fill it in or don't copy it, don't spread the virus).

Thanks
Comment 1 Roan Kattouw 2013-07-19 18:43:08 UTC
Note that there is one (exactly one) piece of useful information in that comment: @abstract
Comment 2 Gerrit Notification Bot 2014-04-09 23:41:20 UTC
Change 125036 had a related patch set uploaded by Krinkle:
Get rid of useless comments for classes

https://gerrit.wikimedia.org/r/125036
Comment 3 Gerrit Notification Bot 2014-04-09 23:42:13 UTC
Change 125036 merged by jenkins-bot:
Get rid of useless comments for classes

https://gerrit.wikimedia.org/r/125036
Comment 4 Gerrit Notification Bot 2014-07-15 21:26:12 UTC
Change 146523 had a related patch set uploaded by Krinkle:
Remove useless documentation, add more useful documentation

https://gerrit.wikimedia.org/r/146523
Comment 5 Gerrit Notification Bot 2014-07-15 21:28:49 UTC
Change 146523 merged by jenkins-bot:
Remove useless documentation, add more useful documentation

https://gerrit.wikimedia.org/r/146523

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links