philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[svn-r29399] HDFFV-9717: add overview section to javadocs

Browse Source
This commit is contained in:
Allen Byrne
2016-03-14 12:51:41 -05:00
parent 8f874a5010
commit 85711b31d8
5 changed files with 166 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
config/cmake/UseJava.cmake
View File

@@ -184,7 +184,7 @@
# This is used by install_jni_symlink().
# 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
# CLASSDIR The directory where the class files can be found. For
# example to use them with javah.
#
# ::
@@ -444,7 +444,7 @@ function(add_jar _TARGET_NAME)
if (_add_jar_MANIFEST)
set(_MANIFEST_OPTION m)
set(_MANIFEST_VALUE ${_add_jar_MANIFEST})
get_filename_component (_MANIFEST_VALUE "${_add_jar_MANIFEST}" ABSOLUTE)
endif ()
if (LIBRARY_OUTPUT_PATH)
@@ -865,6 +865,7 @@ endfunction ()
function(create_javadoc _target)
set(_javadoc_packages)
set(_javadoc_files)
set(_javadoc_overview)
set(_javadoc_sourcepath)
set(_javadoc_classpath)
set(_javadoc_installpath "${CMAKE_INSTALL_PREFIX}/share/javadoc")
@@ -884,6 +885,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -907,6 +910,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -929,6 +934,8 @@ function(create_javadoc _target)
set(_state "packages")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -951,6 +958,8 @@ function(create_javadoc _target)
set(_state "packages")
elseif (${arg} STREQUAL "FILES")
set(_state "files")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -975,6 +984,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "INSTALLPATH")
set(_state "installpath")
elseif (${arg} STREQUAL "DOCTITLE")
@@ -997,6 +1008,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "DOCTITLE")
set(_state "doctitle")
elseif (${arg} STREQUAL "WINDOWTITLE")
@@ -1017,6 +1030,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "INSTALLPATH")
set(_state "installpath")
elseif (${arg} STREQUAL "CLASSPATH")
@@ -1039,6 +1054,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -1061,6 +1078,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -1085,6 +1104,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -1109,6 +1130,8 @@ function(create_javadoc _target)
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "OVERVIEW")
set(_state "overview")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
@@ -1126,6 +1149,30 @@ function(create_javadoc _target)
else ()
set(_javadoc_version ${arg})
endif ()
elseif (${_state} STREQUAL "overview")
if (${arg} STREQUAL "PACKAGES")
set(_state "packages")
elseif (${arg} STREQUAL "FILES")
set(_state "files")
elseif (${arg} STREQUAL "SOURCEPATH")
set(_state "sourcepath")
elseif (${arg} STREQUAL "CLASSPATH")
set(_state "classpath")
elseif (${arg} STREQUAL "INSTALLPATH")
set(_state "installpath")
elseif (${arg} STREQUAL "DOCTITLE")
set(_state "doctitle")
elseif (${arg} STREQUAL "WINDOWTITLE")
set(_state "windowtitle")
elseif (${arg} STREQUAL "AUTHOR")
set(_state "author")
elseif (${arg} STREQUAL "USE")
set(_state "use")
elseif (${arg} STREQUAL "VERSION")
set(_state "version")
else ()
list(APPEND _javadoc_overview ${arg})
endif ()
endif ()
endforeach ()
@@ -1145,6 +1192,19 @@ function(create_javadoc _target)
set(_javadoc_options ${_javadoc_options} -sourcepath ${_sourcepath})
endif ()
if (_javadoc_overview)
set(_start TRUE)
foreach(_path ${_javadoc_overview})
if (_start)
set(_overview ${_path})
set(_start FALSE)
else ()
set(_overview ${_overview}:${_path})
endif ()
endforeach()
set(_javadoc_options ${_javadoc_options} -overview ${_overview})
endif ()
if (_javadoc_classpath)
set(_start TRUE)
foreach(_path ${_javadoc_classpath})
@@ -1212,7 +1272,7 @@ function (create_javah)
set (_output_files)
if (WIN32 AND NOT CYGWIN AND CMAKE_HOST_SYSTEM_NAME MATCHES "Windows")
set(_classpath_sep ";")
set(_classpath_sep "$<SEMICOLON>")
else ()
set(_classpath_sep ":")
endif()
@@ -1242,7 +1302,7 @@ function (create_javah)
endif()
endforeach()
string (REPLACE ";" "${_classpath_sep}" _classpath "${_classpath}")
list (APPEND _javah_options -classpath ${_classpath})
list (APPEND _javah_options -classpath "${_classpath}")
endif()
if (_create_javah_OUTPUT_DIR)