entity set implementation for iMesh and iGeom

[Devine, Karen D]

I agree.

Karen



On 11/6/09 7:41 AM, "Tim Tautges" <tautges at mcs.anl.gov> wrote:

> I strongly agree with Jason's statement.  Documenting the syntax and usage of
> each function in the text of the User's
> Guide as well as the doxygen'd header file will always result in
> inconsistency.  It also obfuscates the important
> information in the User's Guide that does not appear in the header files.  I
> don't see getting rid of the syntax
> documentation in the header, so that means it should be taken out of the
> User's Guide (and the doxygen output should be
> incorporated into an appendix).
> 
> - tim
> 
> Jason Kraftcheck wrote:
>> Mark Shephard wrote:
>>> Is this everything and is it all up to date?
>>> 
>> 
>> I doubt it, but these are supposed to be the most current versions that we
>> have.
>> 
>>> I do not see iMeshP stuff and lots of the stuff is still called TSTT
>>> (which makes me wonder if it is up-to-date).
>>> 
>> 
>> Is there any iMeshP documentation beyond the doxygen-formated comments in
>> the header?
>> 
>> 
>>> If this is not complete or up-to-date, I guess that is one of the
>>> overall software clean-up things we need to get done as part of the
>>> processes we discussed at the last boot camp.
>>> 
>> 
>> Much of the current iGeom and iMesh users' guides are composed of API
>> documentation similar to what is in the doxygen-formatted comments in the
>> headers.  The duplicate effort and potential source of inconsistencies is
>> sub-optimal.  Doxygen can generate latex from the headers that could be
>> included in the users' guides as an appendix.
>> 
>> - jason
>> 
> 
> --
> ================================================================
> "You will keep in perfect peace him whose mind is
>    steadfast, because he trusts in you."               Isaiah 26:3
> 
>               Tim Tautges            Argonne National Laboratory
>           (tautges at mcs.anl.gov)      (telecommuting from UW-Madison)
>           phone: (608) 263-8485      1500 Engineering Dr.
>             fax: (608) 263-4499      Madison, WI 53706
> 
> 
>