Commit efc43cde authored by Stephen Kelly's avatar Stephen Kelly Committed by Brad King

Help: Fix some erroneous code block markers in Module docs.

There are many style errors in these files. This patch fixes only
the syntactical errors.

The script which ported these to rst tripped on some incorrectly
formatted blocks in the original input documentation.  Use a new
script to find problematic code (and then fix them manually):

  #!/usr/bin/env python

  import os

  rootDir = '.'

  def checkFile(fname):

    f = open(fname)
    lines = f.readlines()
    started = False
    counter = 0
    for l in lines:
      if "#" in l:
        started = True
      elif started:
        return
      lin = l.find("(")
      if lin != -1 and l.find(")", lin) == -1 and \
          not "(To distribute this file outside of CMake, substitute the full" in l:
        for lp in lines[counter+1:]:
          if lp == "# ::\n":
            print "\n\n######### " + fname + "\n\n"
            print ''.join(lines[max(counter-2, 0):counter+6])
            break
          elif lp == "#\n" :
            continue
          break
      counter += 1

  for dirName, subdirList, fileList in os.walk(rootDir):
      for fname in fileList:
          checkFile(os.path.join(dirName, fname))
parent 3917d86b
......@@ -2,15 +2,10 @@
# CMakeExpandImportedTargets
# --------------------------
#
#
#
# CMAKE_EXPAND_IMPORTED_TARGETS(<var> LIBRARIES lib1 lib2...libN
#
# ::
#
# [CONFIGURATION <config>] )
#
#
# CMAKE_EXPAND_IMPORTED_TARGETS(<var> LIBRARIES lib1 lib2...libN
# [CONFIGURATION <config>])
#
# CMAKE_EXPAND_IMPORTED_TARGETS() takes a list of libraries and replaces
# all imported targets contained in this list with their actual file
......
......@@ -4,22 +4,15 @@
#
# Convenience macros for printing properties and variables, useful e.g. for debugging.
#
#
#
#
#
# CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN]
#
# ::
#
# CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN]
# [SOURCES source1 .. sourceN]
# [DIRECTORIES dir1 .. dirN]
# [TESTS test1 .. testN]
# [CACHE_ENTRIES entry1 .. entryN]
# PROPERTIES prop1 .. propN )
#
#
#
# This macro prints the values of the properties of the given targets,
# source files, directories, tests or cache entries. Exactly one of the
# scope keywords must be used. Example:
......
......@@ -4,13 +4,10 @@
#
# Check if the given struct or class has the specified member variable
#
# CHECK_STRUCT_HAS_MEMBER (<struct> <member> <header> <variable>
#
# ::
#
# [LANGUAGE <language>])
#
#
# CHECK_STRUCT_HAS_MEMBER(<struct> <member> <header> <variable>
# [LANGUAGE <language>])
#
# ::
#
......
......@@ -8,19 +8,16 @@
# FindJava.cmake has already been loaded. See FindJava.cmake for
# information on how to load Java into your CMake project.
#
# add_jar(target_name
#
# ::
#
# add_jar(target_name
# [SOURCES] source1 [source2 ...] [resource1 ...]
# [INCLUDE_JARS jar1 [jar2 ...]]
# [ENTRY_POINT entry]
# [VERSION version]
# [OUTPUT_NAME name]
# [OUTPUT_DIR dir]
# )
#
#
# )
#
# This command creates a <target_name>.jar. It compiles the given
# source files (source) and adds the given resource files (resource) to
......@@ -189,19 +186,14 @@
# CLASS_DIR The directory where the class files can be found. For
# example to use them with javah.
#
#
#
# find_jar(<VAR>
#
# ::
#
# find_jar(<VAR>
# name | NAMES name1 [name2 ...]
# [PATHS path1 [path2 ... ENV var]]
# [VERSIONS version1 [version2]]
# [DOC "cache documentation string"]
# )
#
#
# )
#
# This command is used to find a full path to the named jar. A cache
# entry named by <VAR> is created to stor the result of this command.
......@@ -216,21 +208,24 @@
# the VERSIONS argument. The argument after DOC will be used for the
# documentation string in the cache.
#
# install_jar(TARGET_NAME DESTINATION)
# ::
#
# 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.
#
# install_jni_symlink(TARGET_NAME DESTINATION)
# ::
#
# 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.
#
# create_javadoc(<VAR>
#
# ::
#
# create_javadoc(<VAR>
# PACKAGES pkg1 [pkg2 ...]
# [SOURCEPATH <sourcepath>]
# [CLASSPATH <classpath>]
......@@ -240,9 +235,7 @@
# [AUTHOR TRUE|FALSE]
# [USE TRUE|FALSE]
# [VERSION TRUE|FALSE]
# )
#
#
# )
#
# Create java documentation based on files or packages. For more
# details please read the javadoc manpage.
......
......@@ -22,11 +22,9 @@
# swig generated module (swig -outdir option) The name-specific variable
# SWIG_MODULE_<name>_EXTRA_DEPS may be used to specify extra
# dependencies for the generated modules. If the source file generated
# by swig need some special flag you can use
# set_source_files_properties( ${swig_generated_file_fullname}
#
# ::
# by swig need some special flag you can use::
#
# set_source_files_properties( ${swig_generated_file_fullname}
# PROPERTIES COMPILE_FLAGS "-bla")
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment