[OpenLayers-Trac] Re: [OpenLayers] #2989: Documentation: some distractions and omissions

[OpenLayers]

#2989: Documentation: some distractions and omissions
---------------------------+------------------------------------------------
 Reporter:  jorix          |       Owner:              
     Type:  bug            |      Status:  new         
 Priority:  trivial        |   Milestone:  2.11 Release
Component:  documentation  |     Version:  2.10        
 Keywords:                 |       State:  Review      
---------------------------+------------------------------------------------

Comment(by jorix):

 Replying to [comment:2 erilem]:
 > Quick question before committing this: is {{{Allowed Options}}} a
 NaturalDocs keyword?

 I think "NatualDocs" does not limit the keywords, "{{{Allowed Options:}}}"
 are currently used in the documentation of OpenLayers.Map, see:
 http://dev.openlayers.org/docs/files/OpenLayers/Map-
 js.html#OpenLayers.Map.getMaxExtent

 ----

 It would be interesting to debate whether to introducucir two new terms in
 the documentation. Closure Compiler gives the following cases WARNING
  * When "this" is used in a non-instantiable object, eg
 "OpenLayers.Util.onImageLoad" (could be used "{{{Scope:}}}")
  * When a function can be called with fewer arguments that have been
 declared, eg "OpenLayers.Util.modifyAlphaImageDiv" (could be used
 "{{{Optional Paramers:}}}")

 This debate is right on this ticket?

 NOTE: I am preparing an automatic translator from "Natural Docs" to
 "jsDoc" (only for use with the compiler) that I have intended to publish
 in another ticket. For a good compilation is required jsDoc + very pure
 JavaScript + adjustments in the documentation as described. oops!, it may
 be too much? :-)

 To compile without concerns see: #2972

-- 
Ticket URL: <http://trac.openlayers.org/ticket/2989#comment:3>
OpenLayers <http://openlayers.org/>
A free AJAX map viewer