<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<div class="moz-cite-prefix">On 14-02-10 10:39 AM, Ian Taylor - NOAA
Federal wrote:<br>
<br>
Perhaps an example is needed.<br>
<br>
At the Seattle workshop (and at the Honolulu workshop and at ...)<br>
I showed how you could define a set of print functions call mp()
(shorter is better for names here,<br>
so that gdb users (included ddd) could use a command like<br>
<br>
call mp(M)<br>
<br>
to print out say a vector or matrix in the debugger. Extend this
to<br>
<br>
call mpc(M,4)<br>
<br>
to print out the 4'th column of a matrix M.<br>
<br>
all this could be extended to all types in an intuitive manner
etc.<br>
<br>
To my knowledge nothing has been done with this. I think it is a
more useful idea than<br>
puking out vast amounts of mindless documentation.<br>
<br>
Just a thought.<br>
<br>
<br>
<br>
<br>
</div>
<blockquote
cite="mid:CAOUH9r7qSSPOqkz3sSC6bpG=SN1Y6iXq3rH-gYcP3NjfWVPmOg@mail.gmail.com"
type="cite">
<div dir="ltr">Hi All,
<div>I wasn't at the most recent Developer's workshop in
Reykjavik, but the report from that workshop <a
moz-do-not-send="true"
href="http://www.admb-project.org/developers/workshop/reykjavik-2013/meeting-report-1"
target="_blank">http://www.admb-project.org/developers/workshop/reykjavik-2013/meeting-report-1</a> 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).</div>
<div><br>
</div>
<div>If the ADMB Developer's Workshop Report isn't a good source
for learning about the ADMB Projects's priorities, what is?</div>
<div>-Ian</div>
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">
On Sat, Feb 8, 2014 at 5:07 PM, John Sibert <span dir="ltr"><<a
moz-do-not-send="true" href="mailto:sibert@hawaii.edu"
target="_blank">sibert@hawaii.edu</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px
0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">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 (<a
moz-do-not-send="true"
href="http://www.admb-project.org/documentation/api/index.html"
target="_blank">http://www.admb-project.org/documentation/api/index.html</a>)
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.<br>
<br>
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.
<div>
<br>
<br>
John Sibert<br>
Emeritus Researcher, SOEST<br>
University of Hawaii at Manoa<br>
Honolulu HI (GMT-10)<br>
<a moz-do-not-send="true" href="tel:808-294-3842"
value="+18082943842" target="_blank">808-294-3842</a><br>
<br>
Visit the ADMB project <a moz-do-not-send="true"
href="http://admb-project.org/" target="_blank">http://admb-project.org/</a><br>
<br>
</div>
<div>
<div>
On 02/07/2014 06:13 PM, dave fournier wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px
0px
0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><br>
<br>
Well I know a bit about a lot of functions, but this
seems like make work to me.<br>
<br>
Could you give me an example of a function for which
more documentation would<br>
suddenly make the sun shine?<br>
_______________________________________________<br>
Developers mailing list<br>
<a moz-do-not-send="true"
href="mailto:Developers@admb-project.org"
target="_blank">Developers@admb-project.org</a><br>
<a moz-do-not-send="true"
href="http://lists.admb-project.org/mailman/listinfo/developers"
target="_blank">http://lists.admb-project.org/mailman/listinfo/developers</a><br>
<br>
</blockquote>
<br>
_______________________________________________<br>
Developers mailing list<br>
<a moz-do-not-send="true"
href="mailto:Developers@admb-project.org"
target="_blank">Developers@admb-project.org</a><br>
<a moz-do-not-send="true"
href="http://lists.admb-project.org/mailman/listinfo/developers"
target="_blank">http://lists.admb-project.org/mailman/listinfo/developers</a><br>
</div>
</div>
</blockquote>
</div>
<br>
</div>
</div>
</blockquote>
<br>
</body>
</html>