[Buildbot] #1839: replace apidocs with something like LXR

[Buildbot trac]

#1839: replace apidocs with something like LXR
-------------------+----------------------
Reporter:  dustin  |       Owner:
    Type:  task    |      Status:  closed
Priority:  major   |   Milestone:  ongoing
 Version:  master  |  Resolution:  fixed
Keywords:  docs    |
-------------------+----------------------
Changes (by dustin):

 * status:  new => closed
 * resolution:   => fixed


Old description:

> The apidocs aren't working out very well, for a few reasons:
>  * they tend to blur the line between public and private APIs
>  * they do not document instance variables very well
>  * we have been very inconsistent in writing docstrings
>  * they're often wrong
>  * they obscure the actual implementation
>
> I think we'd do better to publish annotate, searchable source code -
> something like http://mxr.mozilla.org/.

New description:

 The apidocs aren't working out very well, for a few reasons:
  * they tend to blur the line between public and private APIs
  * they do not document instance variables very well
  * we have been very inconsistent in writing docstrings
  * they're often wrong
  * they obscure the actual implementation

 I think we'd do better to publish annotate, searchable source code -
 something like http://mxr.mozilla.org/.

--

Comment:

 apidocs are long gone

--
Ticket URL: <http://trac.buildbot.net/ticket/1839#comment:3>
Buildbot <http://buildbot.net/>
Buildbot: build/test automation