Java: Fix documentation format and indentation

Modules/UseJava.cmake

@@ -3,175 +3,168 @@
 # has already been loaded.  See FindJava.cmake for information on how to
 # load Java into your CMake project.
 #
-# Available Functions:
+# add_jar(TARGET_NAME SRC1 SRC2 .. SRCN RCS1 RCS2 .. RCSN)
 #
-#  add_jar(TARGET_NAME SRC1 SRC2 .. SRCN RCS1 RCS2 .. RCSN)
+# This command creates a <TARGET_NAME>.jar. It compiles the given source
+# files (SRC) and adds the given resource files (RCS) to the jar file.
+# If only resource files are given then just a jar file is created.
 #
-#  This command creates a <TARGET_NAME>.jar. It compiles the given source
+# Additional instructions:
-#  files (SRC) and adds the given resource files (RCS) to the jar file.
+#   To add compile flags to the target you can set these flags with
-#  If only resource files are given then just a jar file is created.
+#   the following variable:
 #
-#  Additional instructions:
+#       set(CMAKE_JAVA_COMPILE_FLAGS -nowarn)
-#    To add compile flags to the target you can set these flags with
-#    the following variable:
 #
-#        set(CMAKE_JAVA_COMPILE_FLAGS -nowarn)
+#   To add a path or a jar file to the class path you can do this
+#   with the CMAKE_JAVA_INCLUDE_PATH variable.
 #
-#    To add a path or a jar file to the class path you can do this
+#       set(CMAKE_JAVA_INCLUDE_PATH /usr/share/java/shibboleet.jar)
-#    with the CMAKE_JAVA_INCLUDE_PATH variable.
 #
-#        set(CMAKE_JAVA_INCLUDE_PATH /usr/share/java/shibboleet.jar)
+#   To use a different output name for the target you can set it with:
 #
-#    To use a different output name for the target you can set it with:
+#       set(CMAKE_JAVA_TARGET_OUTPUT_NAME shibboleet.jar)
+#       add_jar(foobar foobar.java)
 #
-#        set(CMAKE_JAVA_TARGET_OUTPUT_NAME shibboleet.jar)
+#   To add a VERSION to the target output name you can set it using
-#        add_jar(foobar foobar.java)
+#   CMAKE_JAVA_TARGET_VERSION. This will create a jar file with the name
+#   shibboleet-1.0.0.jar and will create a symlink shibboleet.jar
+#   pointing to the jar with the version information.
 #
-#    To add a VERSION to the target output name you can set it using
+#       set(CMAKE_JAVA_TARGET_VERSION 1.2.0)
-#    CMAKE_JAVA_TARGET_VERSION. This will create a jar file with the name
+#       add_jar(shibboleet shibbotleet.java)
-#    shibboleet-1.0.0.jar and will create a symlink shibboleet.jar
-#    pointing to the jar with the version information.
 #
-#        set(CMAKE_JAVA_TARGET_VERSION 1.2.0)
+#    If the target is a JNI library, utilize the following commands to
-#        add_jar(shibboleet shibbotleet.java)
+#    create a JNI symbolic link:
 #
-#     If the target is a JNI library, utilize the following commands to
+#       set(CMAKE_JNI_TARGET TRUE)
-#     create a JNI symbolic link:
+#       set(CMAKE_JAVA_TARGET_VERSION 1.2.0)
+#       add_jar(shibboleet shibbotleet.java)
+#       install_jar(shibboleet ${LIB_INSTALL_DIR}/shibboleet)
+#       install_jni_symlink(shibboleet ${JAVA_LIB_INSTALL_DIR})
 #
-#        set(CMAKE_JNI_TARGET TRUE)
+#    If a single target needs to produce more than one jar from its
-#        set(CMAKE_JAVA_TARGET_VERSION 1.2.0)
+#    java source code, to prevent the accumulation of duplicate class
-#        add_jar(shibboleet shibbotleet.java)
+#    files in subsequent jars, set/reset CMAKE_JAR_CLASSES_PREFIX prior
-#        install_jar(shibboleet ${LIB_INSTALL_DIR}/shibboleet)
+#    to calling the add_jar() function:
-#        install_jni_symlink(shibboleet ${JAVA_LIB_INSTALL_DIR})
 #
-#     If a single target needs to produce more than one jar from its
+#       set(CMAKE_JAR_CLASSES_PREFIX com/redhat/foo)
-#     java source code, to prevent the accumulation of duplicate class
+#       add_jar(foo foo.java)
-#     files in subsequent jars, set/reset CMAKE_JAR_CLASSES_PREFIX prior
-#     to calling the add_jar() function:
 #
-#        set(CMAKE_JAR_CLASSES_PREFIX com/redhat/foo)
+#       set(CMAKE_JAR_CLASSES_PREFIX com/redhat/bar)
-#        add_jar(foo foo.java)
+#       add_jar(bar bar.java)
 #
-#        set(CMAKE_JAR_CLASSES_PREFIX com/redhat/bar)
+# Target Properties:
-#        add_jar(bar bar.java)
+#   The add_jar() functions sets some target properties. You can get these
+#   properties with the
+#      get_property(TARGET <target_name> PROPERTY <propery_name>)
+#   command.
 #
-#  Target Properties:
+#   INSTALL_FILES      The files which should be installed. This is used by
-#    The add_jar() functions sets some target properties. You can get these
+#                      install_jar().
-#    properties with the
+#   JNI_SYMLINK        The JNI symlink which should be installed.
-#       get_property(TARGET <target_name> PROPERTY <propery_name>)
+#                      This is used by install_jni_symlink().
-#    command.
+#   JAR_FILE           The location of the jar file so that you can include
+#                      it.
+#   CLASS_DIR          The directory where the class files can be found. For
+#                      example to use them with javah.
 #
-#    INSTALL_FILES      The files which should be installed. This is used by
+# find_jar(<VAR>
-#                       install_jar().
+#          name | NAMES name1 [name2 ...]
-#    JNI_SYMLINK        The JNI symlink which should be installed.
+#          [PATHS path1 [path2 ... ENV var]]
-#                       This is used by install_jni_symlink().
+#          [VERSIONS version1 [version2]]
-#    JAR_FILE           The location of the jar file so that you can include
+#          [DOC "cache documentation string"]
-#                       it.
+#         )
-#    CLASS_DIR          The directory where the class files can be found. For
-#                       example to use them with javah.
 #
-#   find_jar(
+# This command is used to find a full path to the named jar. A cache
-#            <VAR>
+# entry named by <VAR> is created to stor the result of this command. If
-#            name | NAMES name1 [name2 ...]
+# the full path to a jar is found the result is stored in the variable
-#            [PATHS path1 [path2 ... ENV var]]
+# and the search will not repeated unless the variable is cleared. If
-#            [VERSIONS version1 [version2]]
+# nothing is found, the result will be <VAR>-NOTFOUND, and the search
-#            [DOC "cache documentation string"]
+# will be attempted again next time find_jar is invoked with the same
-#           )
+# variable.
+# The name of the full path to a file that is searched for is specified
+# by the names listed after NAMES argument. Additional search locations
+# can be specified after the PATHS argument. If you require special a
+# version of a jar file you can specify it with the VERSIONS argument.
+# The argument after DOC will be used for the documentation string in
+# the cache.
 #
-#   This command is used to find a full path to the named jar. A cache
+# install_jar(TARGET_NAME DESTINATION)
-#   entry named by <VAR> is created to stor the result of this command. If
-#   the full path to a jar is found the result is stored in the variable
-#   and the search will not repeated unless the variable is cleared. If
-#   nothing is found, the result will be <VAR>-NOTFOUND, and the search
-#   will be attempted again next time find_jar is invoked with the same
-#   variable.
-#   The name of the full path to a file that is searched for is specified
-#   by the names listed after NAMES argument. Additional search locations
-#   can be specified after the PATHS argument. If you require special a
-#   version of a jar file you can specify it with the VERSIONS argument.
-#   The argument after DOC will be used for the documentation string in
-#   the cache.
 #
-#   install_jar(TARGET_NAME DESTINATION)
+# This command installs the TARGET_NAME files to the given DESTINATION.
+# It should be called in the same scope as add_jar() or it will fail.
 #
-#   This command installs the TARGET_NAME files to the given DESTINATION.
+# install_jni_symlink(TARGET_NAME DESTINATION)
-#   It should be called in the same scope as add_jar() or it will fail.
 #
-#   install_jni_symlink(TARGET_NAME DESTINATION)
+# This command installs the TARGET_NAME JNI symlinks to the given
+# DESTINATION. It should be called in the same scope as add_jar()
+# or it will fail.
 #
-#   This command installs the TARGET_NAME JNI symlinks to the given
+# create_javadoc(<VAR>
-#   DESTINATION. It should be called in the same scope as add_jar()
+#                PACKAGES pkg1 [pkg2 ...]
-#   or it will fail.
+#                [SOURCEPATH <sourcepath>]
+#                [CLASSPATH <classpath>]
+#                [INSTALLPATH <install path>]
+#                [DOCTITLE "the documentation title"]
+#                [WINDOWTITLE "the title of the document"]
+#                [AUTHOR TRUE|FALSE]
+#                [USE TRUE|FALSE]
+#                [VERSION TRUE|FALSE]
+#               )
 #
-#   create_javadoc
+# Create jave documentation based on files or packages. For more
+# details please read the javadoc manpage.
 #
-#     Create jave documentation based on files or packages. For more
+# There are two main signatures for create_javadoc. The first
-#     details please read the javadoc manpage.
+# signature works with package names on a path with source files:
 #
-#     There are two main signatures for create_javadoc. The first
+#   Example:
-#     signature works with package names on a path with source files:
+#   create_javadoc(my_example_doc
+#     PACKAGES com.exmaple.foo com.example.bar
+#     SOURCEPATH ${CMAKE_CURRENT_SOURCE_PATH}
+#     CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH}
+#     WINDOWTITLE "My example"
+#     DOCTITLE "<h1>My example</h1>"
+#     AUTHOR TRUE
+#     USE TRUE
+#     VERSION TRUE
+#   )
 #
-#     create_javadoc(
+# The second signature for create_javadoc works on a given list of
-#                    <VAR>
+# files.
-#                    PACKAGES pkg1 [pkg2 ...]
-#                    [SOURCEPATH <sourcepath>]
-#                    [CLASSPATH <classpath>]
-#                    [INSTALLPATH <install path>]
-#                    [DOCTITLE "the documentation title"]
-#                    [WINDOWTITLE "the title of the document"]
-#                    [AUTHOR TRUE|FALSE]
-#                    [USE TRUE|FALSE]
-#                    [VERSION TRUE|FALSE]
-#                   )
 #
-#     Example:
+#   create_javadoc(<VAR>
-#     create_javadoc(my_example_doc
+#                  FILES file1 [file2 ...]
-#       PACKAGES com.exmaple.foo com.example.bar
+#                  [CLASSPATH <classpath>]
-#       SOURCEPATH ${CMAKE_CURRENT_SOURCE_PATH}
+#                  [INSTALLPATH <install path>]
-#       CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH}
+#                  [DOCTITLE "the documentation title"]
-#       WINDOWTITLE "My example"
+#                  [WINDOWTITLE "the title of the document"]
-#       DOCTITLE "<h1>My example</h1>"
+#                  [AUTHOR TRUE|FALSE]
-#       AUTHOR TRUE
+#                  [USE TRUE|FALSE]
-#       USE TRUE
+#                  [VERSION TRUE|FALSE]
-#       VERSION TRUE
+#                 )
-#     )
 #
-#     The second signature for create_javadoc works on a given list of
+# Example:
-#     files.
+#   create_javadoc(my_example_doc
+#     FILES ${example_SRCS}
+#     CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH}
+#     WINDOWTITLE "My example"
+#     DOCTITLE "<h1>My example</h1>"
+#     AUTHOR TRUE
+#     USE TRUE
+#     VERSION TRUE
+#   )
 #
-#     create_javadoc(
+# Both signatures share most of the options. These options are the
-#                    <VAR>
+# same as what you can find in the javadoc manpage. Please look at
-#                    FILES file1 [file2 ...]
+# the manpage for CLASSPATH, DOCTITLE, WINDOWTITLE, AUTHOR, USE and
-#                    [CLASSPATH <classpath>]
+# VERSION.
-#                    [INSTALLPATH <install path>]
-#                    [DOCTITLE "the documentation title"]
-#                    [WINDOWTITLE "the title of the document"]
-#                    [AUTHOR TRUE|FALSE]
-#                    [USE TRUE|FALSE]
-#                    [VERSION TRUE|FALSE]
-#                   )
 #
-#     Example:
+# The documentation will be by default installed to
-#     create_javadoc(my_example_doc
-#       FILES ${example_SRCS}
-#       CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH}
-#       WINDOWTITLE "My example"
-#       DOCTITLE "<h1>My example</h1>"
-#       AUTHOR TRUE
-#       USE TRUE
-#       VERSION TRUE
-#     )
 #
-#     Both signatures share most of the options. These options are the
+#   ${CMAKE_INSTALL_PREFIX}/share/javadoc/<VAR>
-#     same as what you can find in the javadoc manpage. Please look at
-#     the manpage for CLASSPATH, DOCTITLE, WINDOWTITLE, AUTHOR, USE and
-#     VERSION.
 #
-#     The documentation will be by default installed to
+# if you don't set the INSTALLPATH.
-#
-#       ${CMAKE_INSTALL_PREFIX}/share/javadoc/<VAR>
-#
-#     if you don't set the INSTALLPATH.
 #
 
 #=============================================================================