Argonne National Laboratory

Experimental Physics and
Industrial Control System

2002  2003  2004  2005  2006  2007  2008  2009  2010  <20112012  2013  2014  2015  2016  2017  2018  2019  2020  Index 2002  2003  2004  2005  2006  2007  2008  2009  2010  <20112012  2013  2014  2015  2016  2017  2018  2019  2020 
<== Date ==> <== Thread ==>

Subject: Re: class library header file naming and install conventions
From: Andrew Johnson <anj@aps.anl.gov>
To: "Jeff Hill" <johill@lanl.gov>
Cc: core-talk@aps.anl.gov
Date: Tue, 15 Mar 2011 10:45:21 -0600
On Tuesday 15 March 2011 11:20:44 Jeff Hill wrote:
> The downside maybe is that every manual reads like a
> reference manual, and we are less likely to have a tutorial. We are maybe
> more likely to create human friendly documentation with concept structured
> indexes and html tables if the html is structured by a human?

There are at least two different kinds of programmer documentation; doxygen is 
designed for writing API reference manuals, but not for the other kinds.  Both 
are usually needed, but programmers (myself included) often try to avoid 
writing the other kinds.

Please take a look at Michael's new source layout branch (even write some 
review comments?) before deciding on a new layout.

- Andrew
-- 
An error is only a mistake if you don't learn from it.
When you learn something from it, it becomes a lesson.


References:
class library header file naming and install conventions Jeff Hill
Re: class library header file naming and install conventions Andrew Johnson
RE: class library header file naming and install conventions Jeff Hill

Navigate by Date:
Prev: RE: class library header file naming and install conventions Jeff Hill
Next: Re: class library header file naming and install conventions Ralph Lange
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  <20112012  2013  2014  2015  2016  2017  2018  2019  2020 
Navigate by Thread:
Prev: Re: class library header file naming and install conventions Andrew Johnson
Next: Re: class library header file naming and install conventions Ralph Lange
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  <20112012  2013  2014  2015  2016  2017  2018  2019  2020 
ANJ, 02 Feb 2012 Valid HTML 4.01! · Home · News · About · Base · Modules · Extensions · Distributions · Download ·
· Search · EPICS V4 · IRMIS · Talk · Bugs · Documents · Links · Licensing ·