You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by dl...@apache.org on 2005/10/19 11:48:21 UTC
svn commit: r326513 - in
/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM: INSTALL
LICENSE clean.sh commondox.sh dox.sh echotest.sh getsvndata.sh
getsvndups.sh svnstat.sh undox.sh
Author: dlydick
Date: Wed Oct 19 02:47:54 2005
New Revision: 326513
URL: http://svn.apache.org/viewcvs?rev=326513&view=rev
Log:
Minor documentation adjustments.
Modified:
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/INSTALL
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/LICENSE
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/clean.sh
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/commondox.sh
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/dox.sh
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/echotest.sh
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndata.sh
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndups.sh
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/svnstat.sh
incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/undox.sh
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/INSTALL
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/INSTALL?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/INSTALL (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/INSTALL Wed Oct 19 02:47:54 2005
@@ -5,7 +5,9 @@
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -30,6 +32,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
#
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/LICENSE
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/LICENSE?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/LICENSE (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/LICENSE Wed Oct 19 02:47:54 2005
@@ -5,7 +5,9 @@
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# @verbatim
Apache License
@@ -215,7 +217,9 @@
#
# @date \$LastChangedDate$
#
-# @author Apache Software Foundation \$LastChangedBy$
+# @author \$LastChangedBy$
+#
+# Apache Software Foundation
#
#
#/ /*
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/clean.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/clean.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/clean.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/clean.sh Wed Oct 19 02:47:54 2005
@@ -1,7 +1,7 @@
#!/bin/sh
#
#!
-# @file /home/dlydick/harmony/bootJVM/clean.sh
+# @file /home/dlydick/harmony/bootjvm/bootJVM/clean.sh
#
# @brief Remove build of Boot JVM.
#
@@ -28,12 +28,15 @@
# jni/src/harmony/generic/0.0/clean.sh@endlink
#
#
-# @todo A Windows .BAT version of this script needs to be written
+# @todo HARMONY-6-clean.sh-1 A Windows .BAT version of this script
+# needs to be written
#
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -57,6 +60,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/commondox.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/commondox.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/commondox.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/commondox.sh Wed Oct 19 02:47:54 2005
@@ -10,12 +10,15 @@
# anything on its own.
#
#
-# @todo A Windows .BAT version of this script needs to be written
+# @todo HARMONY-6-commondox.sh-1 A Windows .BAT version of this
+# script needs to be written
#
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -39,6 +42,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/dox.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/dox.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/dox.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/dox.sh Wed Oct 19 02:47:54 2005
@@ -14,18 +14,19 @@
# The reasons are not yet known, and it may be that
# the directive file needs some different settings.
#
-# @todo Identify reason for spurious message on RTF output as
-# described above.
+# @todo HARMONY-6-dox.sh-1 Identify reason for spurious message on
+# RTF output as described above.
#
-# @todo A proper solution to old NetScape 4.7X processing the
-# HTML tag <b><pre class="fragment"></b> syntax needs to be
-# found and implemented so that <b><code></b> and
-# <b>@@verbatim</b> fragments, etc., may be displayed with proper
-# framing @e and with proper newlines and white space. For the
-# interim solution, see the end of this script. The problem will
-# probably be solved by adjusting the <b>doxygen.css</b>
-# (the default @b .css file) or supplying one that is customized
-# for the project or perhaps just for old NetScape browsers.
+# @todo HARMONY-6-dox.sh-2 A proper solution to old NetScape 4.7X
+# processing the HTML tag <b><pre class="fragment"></b>
+# syntax needs to be found and implemented so that
+# <b><code></b> and <b>@@verbatim</b> fragments, etc.,
+# may be displayed with proper framing @e and with proper
+# newlines and white space. For the interim solution, see
+# the end of this script. The problem will probably be
+# solved by adjusting the <b>doxygen.css</b> (the default
+# @b .css file) or supplying one that is customized for
+# the project or perhaps just for old NetScape browsers.
# The scripts @link ./doxpatch.sh doxpatch.sh@endlink and
# @link ./doxunpatch.sh doxunpatch.sh@endlink that support
# the interim solution might also be used in support of the
@@ -39,27 +40,32 @@
# is to find the HTML problem and fix it, probably in the
# style sheet.
#
-# @todo Perhaps the above to-do item should be generalized for the
-# old NetScape 4.7X browser since is seems to have some overall
-# problems with fonts in the default 'doxygen.css' style sheet.
-# Perhaps someone with CSS experience could contribute one or
-# more style sheets for use with different types of browsers so
-# the HTML documents look the same on all of them.
-#
-# @todo Consider the creation of a <b>.css</b> file that is customized
-# especially for this project.
-#
-# @todo A Windows .BAT version of this script needs to be written
-#
-# @bug If the token sequence "@b @c word1 word2..." is used, two
-# words get bolded instead of one (doxygen 1.4.4). Likewise
+# @todo HARMONY-6-dox.sh-3 Perhaps the above to-do item should be
+# generalized for the old NetScape 4.7X browser since is
+# seems to have some overall problems with fonts in the
+# default <b>doxygen.css</b> style sheet. Perhaps someone with
+# CSS experience could contribute one or more style sheets
+# for use with different types of browsers so the HTML
+# documents look the same on all of them.
+#
+# @todo HARMONY-6-dox.sh-4 Consider the creation of a <b>.css</b>
+# file that is customized especially for this project.
+#
+# @todo HARMONY-6-dox.sh-1 A Windows .BAT version of this
+# script needs to be written
+#
+# @bug HARMONY-6-dox.sh-1001 If the token
+# sequence "@b @c word1 word2..." is used, two words
+# get bolded instead of one (Doxygen 1.4.4). Likewise
# with "@b @p word1 word2..." By reversing the sequence,
# only one word gets bolded. Is this a "bug" or a "feature"?
#
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -83,6 +89,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference
@@ -239,7 +246,7 @@
# with shell scripts also.
#
-SHELL1="Warning: Found ';' while parsing initializer list! \(doxygen could be confused by a macro call without semicolon\)"
+SHELL1="Warning: Found ';' while parsing initializer list! \(Doxygen could be confused by a macro call without semicolon\)"
SHELL_FILTER="$SHELL1"
@@ -250,7 +257,7 @@
# configuration file.
#
# With the exception of effects of changing the configuration file,
-# this cleanup step really _could_ be done under the covers by doxygen
+# this cleanup step really _could_ be done under the covers by Doxygen
# by virtue ofthe fact that new output files overwrite old output files,
# but is done here anyway for the sake of being thorough and only
# generating _exactly_ what the current contents of the configuration
@@ -268,7 +275,7 @@
echo " to be non-null in order to not remove all of the"
echo " documentation output files every time and thus run"
echo " faster at the expense of file roster precision due"
- echo " to file add/delete or doxygen directive file changes."
+ echo " to file add/delete or Doxygen directive file changes."
echo ""
fi
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/echotest.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/echotest.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/echotest.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/echotest.sh Wed Oct 19 02:47:54 2005
@@ -21,7 +21,9 @@
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -45,6 +47,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndata.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndata.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndata.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndata.sh Wed Oct 19 02:47:54 2005
@@ -18,20 +18,25 @@
# ./getsvndups.sh getsvndups.sh@endlink
# to show this type of analysis.
#
-# The macro @link #ARCH_COPYRIGHT_APACHE() ARCH_COPYRIGHT_APACHE@endlink
-# generates the appropriate data from the expansion of SubVersion (SVN)
-# keywords that are stored in a static string in each compiled object
-# file. This data is promoted at link time to be stored in the
+# The @link #ARCH_HEADER_COPYRIGHT_APACHE() ARCH_HEADER_COPYRIGHT_APACHE@endlink
+# and
+# @link #ARCH_SOURCE_COPYRIGHT_APACHE() ARCH_SOURCE_COPYRIGHT_APACHE@endlink
+# macros generate the appropriate data from the expansion of SubVersion
+# (SVN) keywords that are stored in a static string in each compiled
+# object file. This data is promoted at link time to be stored in the
# linked binary explicitly for use by this reporting script.
#
# @see getsvndups.sh
#
-# @todo A Windows .BAT version of this script needs to be written
+# @todo HARMONY-6-getsvndata.sh-1 A Windows .BAT version of this
+# script needs to be written
#
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -55,6 +60,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndups.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndups.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndups.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/getsvndups.sh Wed Oct 19 02:47:54 2005
@@ -15,20 +15,26 @@
# To report the versions of all source files represented in the
# binary, use @link ./getsvndata.sh getsvndata.sh@endlink.
#
-# The macro @link #ARCH_COPYRIGHT_APACHE() ARCH_COPYRIGHT_APACHE@endlink
-# generates the appropriate data from the expansion of SubVersion (SVN)
-# keywords that are stored in a static string in each compiled object
-# file. This data is promoted at link time to be stored in the
+# The
+# @link #ARCH_HEADER_COPYRIGHT_APACHE() ARCH_HEADER_COPYRIGHT_APACHE@endlink
+# and
+# @link #ARCH_SOURCE_COPYRIGHT_APACHE() ARCH_SOURCE_COPYRIGHT_APACHE@endlink
+# macros generate the appropriate data from the expansion of SubVersion
+# (SVN) keywords that are stored in a static string in each compiled
+# object file. This data is promoted at link time to be stored in the
# linked binary explicitly for use by this reporting script.
#
# @see getsvndata.sh
#
-# @todo A Windows .BAT version of this script needs to be written
+# @todo HARMONY-6-getsvndups.sh-1 A Windows .BAT version of this
+# script needs to be written
#
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -52,6 +58,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/svnstat.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/svnstat.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/svnstat.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/svnstat.sh Wed Oct 19 02:47:54 2005
@@ -6,8 +6,8 @@
# @brief Per doxygen @b config.html recommendation for
# FILE_VERSION_FILTER
#
-# @todo The @c @b sed(1) command as documented is not valid. See also
-# the @@bug entry for this script.
+# @todo HARMONY-6-svnstat.sh-1 The @c @b sed(1) command as documented
+# is not valid. See also @@bug entry HARMONY-6-svnstat.sh-1001.
#
# @verbatim
#
@@ -19,7 +19,9 @@
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -43,13 +45,15 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference
#
-# @bug The @c @b sed(1) string recommended in the Doxygen narrative
-# needs fixing. It is reported here verbatim, but it is possible
-# that the number of backslash characters is not correct.
+# @bug HARMONY-6-svnstat.sh-1001 The @c @b sed(1) string recommended in
+# the Doxygen narrative needs fixing. It is reported here
+# verbatim, but it is possible that the number of backslash
+# characters is not correct.
#
#/ /*
# (Use #! and #/ with dox_filter.sh to fool Doxygen into
Modified: incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/undox.sh
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/undox.sh?rev=326513&r1=326512&r2=326513&view=diff
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/undox.sh (original)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/bootjvm/bootJVM/undox.sh Wed Oct 19 02:47:54 2005
@@ -7,12 +7,15 @@
# Simply remove the documenation directory.
#
#
-# @todo A Windows .BAT version of this script needs to be written
+# @todo HARMONY-6-undox.sh-1 A Windows .BAT version of this
+# script needs to be written
#
#
# @section Control
#
-# \$URL$ \$Id$
+# \$URL$
+#
+# \$Id$
#
# Copyright 2005 The Apache Software Foundation
# or its licensors, as applicable.
@@ -36,6 +39,7 @@
# @date \$LastChangedDate$
#
# @author \$LastChangedBy$
+#
# Original code contributed by Daniel Lydick on 09/28/2005.
#
# @section Reference