[Developers] Request documentation help

[dave fournier]

On 14-02-12 12:29 PM, John Sibert wrote:


So at the time there was nice documentation for a feature that wasn't 
actually in the release.
I guess that makes my point.


> http://www.admb-project.org/documentation/api/gdbprintlib_8cpp.html
>
> John Sibert
> Emeritus Researcher, SOEST
> University of Hawaii at Manoa
> Honolulu HI (GMT-10)
> 808-294-3842
>
> Visit the ADMB project http://admb-project.org/
>
> On 02/12/2014 07:55 AM, dave fournier wrote:
>> On 14-02-10 10:39 AM, Ian Taylor - NOAA Federal wrote:
>>
>> Perhaps an example is needed.
>>
>> At the Seattle  workshop (and at the Honolulu workshop and at ...)
>> I showed how you could define a set of print functions call mp() 
>> (shorter is better for names here,
>> so that gdb users (included ddd) could use a command like
>>
>>    call mp(M)
>>
>> to print out say a vector or matrix in the debugger. Extend this to
>>
>>     call mpc(M,4)
>>
>> to  print out the 4'th column of a matrix M.
>>
>> all this could be extended to all types in an intuitive manner etc.
>>
>> To my knowledge nothing has been done with this.  I think it is a 
>> more useful idea than
>> puking out vast amounts of mindless documentation.
>>
>> Just a thought.
>>
>>
>>
>>
>>> Hi All,
>>> I wasn't at the most recent Developer's workshop in Reykjavik, but 
>>> the report from that workshop 
>>> http://www.admb-project.org/developers/workshop/reykjavik-2013/meeting-report-1 
>>> seems relevant to this discussion. It says "Ongoing improvement of 
>>> ADMB documentation has been a long-standing priority area of the 
>>> ADMB project" (page 9), and lists "Add new Doxygen comments" among 
>>> the "Priorities for Documentation" along with things like "Update 
>>> manuals" and clean up the website (page 12).
>>>
>>> If the ADMB Developer's Workshop Report isn't a good source for 
>>> learning about the ADMB Projects's priorities, what is?
>>> -Ian
>>>
>>>
>>> On Sat, Feb 8, 2014 at 5:07 PM, John Sibert <sibert at hawaii.edu 
>>> <mailto:sibert at hawaii.edu>> wrote:
>>>
>>>     I couldn't agree more. Documenting every function in every source
>>>     file would be a tragic waste of time and would not lead to a
>>>     better user experience. The emphasis on documentation may come
>>>     from some nameless NOAA bureaucrat ignorant of the fact that
>>>     there is already a lot API and other documentation. The ADMB API
>>>     documentation
>>>     (http://www.admb-project.org/documentation/api/index.html) has a
>>>     nicely indexed list of commonly used functions on the "Function
>>>     Reference" tab. Classes and global functions are also indexed,
>>>     and there is a Search box.
>>>
>>>     The documentation seems to grow as more people contribute. All of
>>>     the contributed libraries are well documented. Steve Martel and
>>>     others have added Dox. Johnoel was trying to encourage other
>>>     developers to contribute as well. I tend to add Doxygen stuff
>>>     when a question pops up in an email or  when I get curious about
>>>     how something actually works. I would encourage others to do the
>>>     same.
>>>
>>>
>>>     John Sibert
>>>     Emeritus Researcher, SOEST
>>>     University of Hawaii at Manoa
>>>     Honolulu HI (GMT-10)
>>>     808-294-3842 <tel:808-294-3842>
>>>
>>>     Visit the ADMB project http://admb-project.org/
>>>
>>>     On 02/07/2014 06:13 PM, dave fournier wrote:
>>>
>>>
>>>
>>>         Well I know a bit about a lot of functions, but this seems
>>>         like make work to me.
>>>
>>>         Could you give me an example of a function for which more
>>>         documentation would
>>>         suddenly make the sun shine?
>>>         _______________________________________________
>>>         Developers mailing list
>>>         Developers at admb-project.org 
>>> <mailto:Developers at admb-project.org>
>>> http://lists.admb-project.org/mailman/listinfo/developers
>>>
>>>
>>>     _______________________________________________
>>>     Developers mailing list
>>>     Developers at admb-project.org <mailto:Developers at admb-project.org>
>>>     http://lists.admb-project.org/mailman/listinfo/developers
>>>
>>>
>>
>
>