[Dart-dev] DART/branches Revision: 13136

[dart at ucar.edu]

nancy at ucar.edu
2019-04-30 09:20:44 -0600 (Tue, 30 Apr 2019)
117
try to make the instructions a bit clearer. fix the output
message that prints where the files are being generated.




Modified: DART/branches/rma_trunk/documentation/doxygen/README
===================================================================
--- DART/branches/rma_trunk/documentation/doxygen/README	2019-04-27 18:59:42 UTC (rev 13135)
+++ DART/branches/rma_trunk/documentation/doxygen/README	2019-04-30 15:20:44 UTC (rev 13136)
@@ -8,7 +8,7 @@
 
 To create html pages from the DART source:
 
-- You must have doxygen installed somewhere on your search path.  
+- You must have 'doxygen' installed somewhere on your search path.  
   From a terminal window type 'which doxygen'.  For Linux systems
   in many cases this is already installed.  For Macs try one of
   the package managers like 'macports'.  The GUI download .dmg
@@ -21,21 +21,21 @@
   cd into that directory and run the './gendocs' shell script.  It will 
   generate a single index.html main page plus separate documentation pages 
   for each executable that has a mkmf_xxx and path_names_xxx pair of files 
-  in the work directory.  All documentation will be created and put under 
-  $DART/documentation/doxygen/model_name.
+  in the work directory. The last output lines of the script will echo 
+  where the html files have been created.
 
   To create documentation with diagrams of 'used by' and 'uses', run
-  './gendocs -devel' to enable the development diagrams.
+  './gendocs -devel' to enable the development diagrams.  This takes
+  longer to run and requires the 'dot' utility.
 
 
 To use the documentation:
 
-- Open $DART/documentation/doxygen/model_name/index.html in a browser and click
-  on any executable name.
+- Open index.html in a browser and click on any executable name.
 
 - Click on the triangle in front of 'Data Types List' to open the list.
 
-- There is a second 'Data Types List'.  Click on that triangle in
+- There may be a second 'Data Types List'.  Click on that triangle in
   front of the second 'Data Types List' to open the list. You
   should see a list of modules.
 
@@ -50,6 +50,7 @@
 - Any text in blue can be clicked on and it will take you to the
   reference page for that type, function or subroutine.
 
+
 # <next few lines under version control, do not edit>
 # $URL$
 # $Revision$

Modified: DART/branches/rma_trunk/documentation/doxygen/gendocs
===================================================================
--- DART/branches/rma_trunk/documentation/doxygen/gendocs	2019-04-27 18:59:42 UTC (rev 13135)
+++ DART/branches/rma_trunk/documentation/doxygen/gendocs	2019-04-30 15:20:44 UTC (rev 13136)
@@ -12,7 +12,7 @@
 # before using this script, copy it to a model's work directory, along 
 # with one of the doxygen configuration template files listed below.
 
-# pick one: the second tries to create diagrams showing the calling
+# pick one: the "devel" version tries to create diagrams showing the calling
 # and called relationship between subroutines, but the number and size
 # of files it generates is much larger.