init
This commit is contained in:
@@ -0,0 +1,159 @@
|
||||
# Author Yann Renard / INRIA
|
||||
# Date 2008-10-15
|
||||
#
|
||||
# this CMake script iterates over several source documentation directories in
|
||||
# order to compile it with doxygen. It has the ability to configure the
|
||||
# doxyfile depending on some variables and to build documentation sources from
|
||||
# computer generated templates (.dox-skeleton) and hand written documentation
|
||||
# parts (.dox-part)
|
||||
|
||||
ADD_CUSTOM_TARGET(${PROJECT_NAME} ALL)
|
||||
|
||||
# look for doxygen, if not present, no need to generate documentation
|
||||
FIND_PROGRAM(doxygen_bin "doxygen" PATHS ${LIST_DEPENDENCIES_PATH}/bin NO_DEFAULT_PATH)
|
||||
FIND_PROGRAM(doxygen_bin "doxygen" PATHS ${LIST_DEPENDENCIES_PATH}/bin "C:/Program Files/doxygen/bin")
|
||||
|
||||
IF(doxygen_bin)
|
||||
|
||||
MESSAGE(STATUS " Found doxygen...")
|
||||
|
||||
# intializes the variable that will be used in the doxyfile for input
|
||||
# directories
|
||||
STRING(REPLACE "\\" "/" ov_doxy_input "${OV_BASE_DIR}/cmake-modules")
|
||||
SET(ov_doxy_input "\\\"${ov_doxy_input}\\\"")
|
||||
|
||||
# intializes the variable that will contain the list of resource files to
|
||||
# copy to the target directory
|
||||
SET(RESOURCE_FILES "")
|
||||
|
||||
SET(DOX_PART_FILES "")
|
||||
# iterates on each project we have
|
||||
#
|
||||
# for each project, we look at its resources and store them in a list
|
||||
# for each project, we look at partial documentation files (.dox-part) and
|
||||
# parse them to get |ov[a-zA-Z0-9_]*_begin| or |ov[a-zA-Z0-9_]*_end|
|
||||
# tokens. This tokens will later be included in the skeleton doxumentation
|
||||
# files (.dox-skeleton)
|
||||
GET_PROPERTY(CURRENT_PROJECTS GLOBAL PROPERTY OV_PROP_CURRENT_PROJECTS)
|
||||
|
||||
FOREACH(current_project ${CURRENT_PROJECTS})
|
||||
# MESSAGE(STATUS " [ OK ] Project ${current_project}")
|
||||
|
||||
STRING(REGEX REPLACE " +$" "" current_project ${current_project})
|
||||
|
||||
# updates the doxyfile variable for input directories
|
||||
IF(EXISTS "${current_project}/include")
|
||||
SET(current_project_include "${current_project}/include")
|
||||
SET(ov_doxy_input "${ov_doxy_input} \\\"${current_project_include}\\\"")
|
||||
ENDIF(EXISTS "${current_project}/include")
|
||||
|
||||
IF(EXISTS "${current_project}/src")
|
||||
# MESSAGE(STATUS " [ OK ] Candidate src directory found ${current_project_src}")
|
||||
SET(current_project_src "${current_project}/src")
|
||||
SET(ov_doxy_input "${ov_doxy_input} \\\"${current_project_src}\\\"")
|
||||
ENDIF(EXISTS "${current_project}/src")
|
||||
|
||||
IF(EXISTS "${current_project}/doc")
|
||||
# MESSAGE(STATUS " [ OK ] Candidate doc directory found ${current_project_doc}")
|
||||
SET(current_project_doc "${current_project}/doc")
|
||||
SET(ov_doxy_input "${ov_doxy_input} \\\"${current_project_doc}\\\"")
|
||||
|
||||
# looks for resources and stores them in a list
|
||||
FILE(GLOB_RECURSE resource_files_tmp "${current_project_doc}/*.png" "${current_project_doc}/*.svg" "${current_project_doc}/*.css" "${current_project_doc}/*.php")
|
||||
SET(RESOURCE_FILES ${RESOURCE_FILES} ${resource_files_tmp})
|
||||
|
||||
# looks for partial hand written documentation
|
||||
FILE(GLOB_RECURSE doxs "${current_project_doc}/*.dox-part")
|
||||
SET(DOX_PART_FILES "${DOX_PART_FILES};${doxs}")
|
||||
ENDIF(EXISTS "${current_project}/doc")
|
||||
|
||||
IF(EXISTS "${current_project}/box-algorithm-doc")
|
||||
|
||||
LIST(APPEND dir_list "." "box-algorithm-doc/dox-part")
|
||||
FOREACH(file_path ${dir_list})
|
||||
SET(current_project_doc "${current_project}/${file_path}")
|
||||
MESSAGE(STATUS " [ OK ] Candidate doc directory found ${current_project_doc}")
|
||||
SET(ov_doxy_input "${ov_doxy_input} \\\"${current_project_doc}\\\"")
|
||||
|
||||
# looks for resources and stores them in a list
|
||||
FILE(GLOB_RECURSE resource_files_tmp "${current_project_doc}/*.png" "${current_project_doc}/*.svg" "${current_project_doc}/*.css" "${current_project_doc}/*.php")
|
||||
SET(RESOURCE_FILES ${RESOURCE_FILES} ${resource_files_tmp})
|
||||
|
||||
# looks for partial hand written documentation
|
||||
FILE(GLOB_RECURSE doxs "${current_project_doc}/*.dox-part")
|
||||
SET(DOX_PART_FILES "${DOX_PART_FILES};${doxs}")
|
||||
ENDFOREACH(file_path ${dir_list})
|
||||
|
||||
ENDIF(EXISTS "${current_project}/box-algorithm-doc")
|
||||
|
||||
|
||||
|
||||
ENDFOREACH(current_project)
|
||||
|
||||
# the final doxyfile filename is generated, platform compliantly
|
||||
SET(ov_doxy_final "${CMAKE_CURRENT_BINARY_DIR}/doxyfile")
|
||||
IF(WIN32)
|
||||
STRING(REPLACE "/" "\\\\" ov_doxy_final ${ov_doxy_final})
|
||||
ENDIF(WIN32)
|
||||
|
||||
# these two lines configure the variables used to configure the doxyfile
|
||||
SET(ov_doxy_input "${ov_doxy_input} \\\"${CMAKE_CURRENT_SOURCE_DIR}\\\"")
|
||||
SET(ov_doxy_input "${ov_doxy_input} \\\"${CMAKE_CURRENT_BINARY_DIR}\\\"")
|
||||
SET(ov_doxy_strip_from_path ${ov_doxy_input})
|
||||
SET(ov_doxy_version ${PROJECT_VERSION})
|
||||
|
||||
# then the doxyfile is configured
|
||||
|
||||
GET_PROPERTY(CURRENT_PROJECTS GLOBAL PROPERTY OV_PROP_CURRENT_PROJECTS_BUILD_DIR)
|
||||
FOREACH(current_project ${CURRENT_PROJECTS})
|
||||
# MESSAGE(STATUS "DUH ${current_project}")
|
||||
STRING(REGEX REPLACE " +$" "" current_project ${current_project})
|
||||
SET(current_project_src "${current_project}/src")
|
||||
# updates the doxyfile variable for input directories
|
||||
SET(ov_plugin_inspector_load_path "${ov_plugin_inspector_load_path}:${current_project}")
|
||||
ENDFOREACH(current_project)
|
||||
|
||||
# create folder to put the output from doxygen to
|
||||
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/../doc")
|
||||
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/../doc/html")
|
||||
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/algorithm-doc")
|
||||
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/algorithm-snapshots")
|
||||
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/box-algorithm-doc")
|
||||
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/box-algorithm-snapshots")
|
||||
# then the doxyfile is configured
|
||||
|
||||
CONFIGURE_FILE(
|
||||
CreateDoxygen.cmake-skeleton
|
||||
CreateDoxygen.cmake
|
||||
@ONLY)
|
||||
|
||||
CONFIGURE_FILE(
|
||||
openvibe.dox-base
|
||||
openvibe.dox
|
||||
@ONLY)
|
||||
|
||||
IF(WIN32)
|
||||
ADD_CUSTOM_COMMAND(
|
||||
TARGET ${PROJECT_NAME}
|
||||
POST_BUILD
|
||||
COMMAND ${LIST_DEPENDENCIES_PATH}/cmake/bin/cmake.exe -P CreateDoxygen.cmake
|
||||
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
|
||||
)
|
||||
ELSEIF(UNIX)
|
||||
ADD_CUSTOM_COMMAND(
|
||||
TARGET ${PROJECT_NAME}
|
||||
POST_BUILD
|
||||
COMMAND cmake -P CreateDoxygen.cmake
|
||||
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
|
||||
)
|
||||
ENDIF(WIN32)
|
||||
|
||||
INSTALL(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../doc/" DESTINATION ${DIST_DOCDIR})
|
||||
|
||||
ELSE(doxygen_bin)
|
||||
|
||||
MESSAGE(STATUS " FAILED to find doxygen...")
|
||||
|
||||
ENDIF(doxygen_bin)
|
||||
|
||||
|
||||
@@ -0,0 +1,197 @@
|
||||
# Author Yann Renard / INRIA
|
||||
# Date 2008-10-15
|
||||
#
|
||||
# this CMake script iterates over several source documentation directories in
|
||||
# order to compile it with doxygen. It has the ability to configure the
|
||||
# doxyfile depending on some variables and to build documentation sources from
|
||||
# computer generated templates (.dox-skeleton) and hand written documentation
|
||||
# parts (.dox-part)
|
||||
|
||||
MESSAGE(STATUS "Launching Create Doxygen CMake script")
|
||||
|
||||
SET(RESOURCE_FILES "@RESOURCE_FILES@")
|
||||
SET(ov_doxy_final "@ov_doxy_final@")
|
||||
SET(ov_doxy_version "@ov_doxy_version@")
|
||||
SET(ov_doxy_input "@ov_doxy_input@")
|
||||
SET(CURRENT_PROJECTS "@CURRENT_PROJECTS@")
|
||||
SET(CMAKE_CURRENT_SOURCE_DIR "@CMAKE_CURRENT_SOURCE_DIR@")
|
||||
|
||||
MESSAGE(STATUS "Running plugin inspector")
|
||||
|
||||
#MESSAGE(STATUS "@CMAKE_INSTALL_FULL_BINDIR@/../lib/")
|
||||
IF(UNIX)
|
||||
EXECUTE_PROCESS(
|
||||
COMMAND @CMAKE_INSTALL_FULL_BINDIR@/../openvibe-plugin-inspector.sh
|
||||
-d "@CMAKE_CURRENT_BINARY_DIR@" -p @CMAKE_INSTALL_FULL_BINDIR@/../lib/
|
||||
-k "@CMAKE_INSTALL_FULL_BINDIR@/../lib/"
|
||||
-c "@CMAKE_INSTALL_FULL_BINDIR@/../share/openvibe/kernel/openvibe.conf"
|
||||
WORKING_DIRECTORY "@CMAKE_INSTALL_FULL_BINDIR@/"
|
||||
)
|
||||
ELSEIF(WIN32)
|
||||
EXECUTE_PROCESS(
|
||||
COMMAND @CMAKE_INSTALL_FULL_BINDIR@/../openvibe-plugin-inspector.cmd
|
||||
-d "@CMAKE_CURRENT_BINARY_DIR@" -p @CMAKE_INSTALL_FULL_BINDIR@
|
||||
-k "@CMAKE_INSTALL_FULL_BINDIR@"
|
||||
-c "@CMAKE_INSTALL_FULL_BINDIR@/../share/openvibe/kernel/openvibe.conf"
|
||||
WORKING_DIRECTORY "@CMAKE_INSTALL_FULL_BINDIR@/"
|
||||
)
|
||||
ENDIF(UNIX)
|
||||
|
||||
#go through all of the .dox-part files we have found previously and extract information
|
||||
FOREACH(dox @DOX_PART_FILES@)
|
||||
GET_FILENAME_COMPONENT(dox_filename ${dox} NAME_WE)
|
||||
MESSAGE(STATUS " Documentation part found ${dox}")
|
||||
|
||||
SET(dox_tag_name NOTFOUND)
|
||||
|
||||
# iterates on each line of the file to look after begin/end tags
|
||||
# "dox_tag_name" stores the name of the variable
|
||||
# to use to configure the skeleton file. It is computed from the
|
||||
# begin tag.
|
||||
FILE(READ ${dox} dox_lines)
|
||||
# replaces empty cariage returns with semi colons to be compliant
|
||||
# with CMake lists. note the space before and after the semi
|
||||
# colon, this is for CMake not to skip empty lines
|
||||
STRING(REPLACE "\n" " ; " dox_lines " ${dox_lines} ")
|
||||
FOREACH(dox_line ${dox_lines})
|
||||
# this regex removes the spaces we added before the loop
|
||||
STRING(REGEX REPLACE "^ (.*) $" "\\1" dox_line ${dox_line})
|
||||
|
||||
# we initialize several variables that will be used in
|
||||
# this loop
|
||||
SET(dox_line_processed FALSE)
|
||||
SET(dox_tag_begin NOTFOUND)
|
||||
SET(dox_tag_end NOTFOUND)
|
||||
SET(dox_tag NOTFOUND)
|
||||
|
||||
# and look for a new tag in this line
|
||||
STRING(REGEX MATCH "\\|[a-zA-Z0-9_]+\\|" dox_tag "${dox_line}")
|
||||
IF(dox_tag)
|
||||
# a tag is found, so we want to know if it is a
|
||||
# OVP_DocBegin* or OVP_DocEnd* tag
|
||||
STRING(REGEX MATCH "\\|OVP_DocBegin_[a-zA-Z0-9_]*\\|" dox_tag_begin "${dox_line}")
|
||||
STRING(REGEX MATCH "\\|OVP_DocEnd_[a-zA-Z0-9_]*\\|" dox_tag_end "${dox_line}")
|
||||
|
||||
# in case we already have something in
|
||||
# dox_tag_name, it means that begin tag has
|
||||
# already been processed, so either we terminate with end
|
||||
# tag, either we continue with come content to add in the
|
||||
# variable
|
||||
IF(dox_tag_name AND dox_tag_end)
|
||||
# in case we find end tag, we just terminate cleaning
|
||||
# the tag and what follows. We then terminate and
|
||||
# create a new CMake variable with the content of this
|
||||
# begin/end tagged things.
|
||||
STRING(REGEX REPLACE ".*\\|OVP_DocEnd_([a-zA-Z0-9_]*)\\|.*" "\\1" dox_tag_name_check ${dox_line})
|
||||
STRING(REGEX REPLACE "\\|OVP_DocEnd_([a-zA-Z0-9_]*)\\|.*" "" dox_line "${dox_line}")
|
||||
|
||||
# MESSAGE(STATUS " - Completed tag pair |${dox_tag_name}|")
|
||||
|
||||
SET(dox_tag_name_value "${dox_tag_name_value}\n${dox_line}")
|
||||
SET("Doc_${dox_tag_name}_Content" ${dox_tag_name_value})
|
||||
SET(dox_tag_name NOTFOUND)
|
||||
SET(dox_line_processed TRUE)
|
||||
ENDIF(dox_tag_name AND dox_tag_end)
|
||||
|
||||
# in case dox_tag_name is empty, it means
|
||||
# that begin tag has not yet been found, so we just look at it
|
||||
# or skip to next line
|
||||
IF(NOT dox_tag_name AND dox_tag_begin)
|
||||
# in case we find begin tag, we just start saving the
|
||||
# CMake variable name, and clean the tag and what
|
||||
# comes before. We then intialize the content of the
|
||||
# begin/end tagged thing with what comes after begin
|
||||
# tag.
|
||||
STRING(REGEX REPLACE ".*\\|OVP_DocBegin_([a-zA-Z0-9_]*)\\|.*" "\\1" dox_tag_name ${dox_line})
|
||||
STRING(REGEX REPLACE ".*\\|OVP_DocBegin_([a-zA-Z0-9_]*)\\|" "" dox_line "${dox_line}")
|
||||
SET(dox_tag_name_value "${dox_line}")
|
||||
SET(dox_line_processed TRUE)
|
||||
ENDIF(NOT dox_tag_name AND dox_tag_begin)
|
||||
|
||||
# in case dox tag is not OVP_DocBegin* or OVP_DocEnd*
|
||||
# just print a warning and continue
|
||||
IF(NOT dox_line_processed)
|
||||
MESSAGE(STATUS " - Unexpected tag ${dox_tag} in ${dox} will be ignored")
|
||||
ENDIF(NOT dox_line_processed)
|
||||
ENDIF(dox_tag)
|
||||
|
||||
# in case this line was not processed, either because it does
|
||||
# not have any tag, either because the tag was unexpected, we
|
||||
# just append the whole line to the content of the current
|
||||
# variable
|
||||
IF(dox_tag_name AND NOT dox_line_processed)
|
||||
# in case we don't find the end tag, just append this
|
||||
# new line to the current content
|
||||
SET(dox_tag_name_value "${dox_tag_name_value}\n${dox_line}")
|
||||
ENDIF(dox_tag_name AND NOT dox_line_processed)
|
||||
ENDFOREACH(dox_line)
|
||||
|
||||
ENDFOREACH(dox)
|
||||
|
||||
|
||||
|
||||
# install the remaining resource files
|
||||
|
||||
# now we have stored all the begin/end tagged things in variable, we just
|
||||
# have to configure the skeleton configuration files with those variables.
|
||||
# note that the skeleton files should be prepared to receive the CMake
|
||||
# variables with anywhere it is needed.
|
||||
#
|
||||
# in order to do so, we look after all the (.dox-skeleton) files and call
|
||||
# the configure command to build the final documentation (.dox) file.
|
||||
MESSAGE(STATUS "Current bin dir: @CMAKE_CURRENT_BINARY_DIR@")
|
||||
FILE(GLOB_RECURSE dox_skeletons "@CMAKE_CURRENT_BINARY_DIR@/*.dox-skeleton")
|
||||
FOREACH(dox_skeleton ${dox_skeletons})
|
||||
GET_FILENAME_COMPONENT(dox_skeleton_filename ${dox_skeleton} NAME_WE)
|
||||
CONFIGURE_FILE(
|
||||
"${dox_skeleton}"
|
||||
"@CMAKE_CURRENT_BINARY_DIR@/${dox_skeleton_filename}.dox"
|
||||
@ONLY)
|
||||
# MESSAGE(STATUS " [ OK ] Configured skeleton ${dox_skeleton}")
|
||||
ENDFOREACH(dox_skeleton)
|
||||
|
||||
|
||||
|
||||
|
||||
CONFIGURE_FILE(
|
||||
"@CMAKE_CURRENT_SOURCE_DIR@/doxyfile-skeleton"
|
||||
${ov_doxy_final}
|
||||
@ONLY)
|
||||
|
||||
|
||||
# and a post-build command is added in order to run doxygen
|
||||
MESSAGE(STATUS "Running doxygen")
|
||||
EXECUTE_PROCESS(
|
||||
COMMAND "@doxygen_bin@" "@ov_doxy_final@"
|
||||
WORKING_DIRECTORY "@CMAKE_CURRENT_BINARY_DIR@"
|
||||
)
|
||||
|
||||
# 'patch' the docs, this takes some time, is it worth doing it?
|
||||
# original linux-build directive:
|
||||
# find $target_dist/doc -name *.html -exec sed -i -e "s/\xC2\?\xA7OpenViBE\xC2\?\xA7/OpenViBE/g" "{}" \;
|
||||
# \xC2\?\xA7 is the character that has been put everywhere to clearly make the distinction between the project and the software
|
||||
#MESSAGE(STATUS "Patching special characters in HTML docs ...")
|
||||
#FILE(GLOB_RECURSE HTML_DOCS "${CMAKE_CURRENT_BINARY_DIR}/../doc/html/*.html")
|
||||
#MESSAGE(STATUS "IAMIN ${CMAKE_CURRENT_BINARY_DIR}/../doc/html/")
|
||||
|
||||
#MESSAGE(STATUS "got ${HTML_DOCS}")
|
||||
#FOREACH(HTML_DOC ${HTML_DOCS})
|
||||
# MESSAGE(STATUS "Processing ${HTML_DOC}")
|
||||
# FILE(READ ${HTML_DOC} ORIG_FILE)
|
||||
# STRING(REGEX REPLACE "[^ a-zA-Z0-9:.,]OpenViBE[^ a-zA-Z0-9:.,]" "OpenViBE" TRANSLATED_FILE ${ORIG_FILE})
|
||||
# FILE(WRITE ${HTML_DOC} ${TRANSLATED_FILE})
|
||||
#ENDFOREACH(HTML_DOC)
|
||||
|
||||
FILE(GLOB_RECURSE resource_files_tmp "@CMAKE_CURRENT_BINARY_DIR@/*.png")
|
||||
SET(RESOURCE_FILES ${RESOURCE_FILES} ${resource_files_tmp})
|
||||
|
||||
# hax to install all files under the doc/html folder in the script-launched installer
|
||||
FILE(GLOB_RECURSE resource_files_tmp "@CMAKE_CURRENT_BINARY_DIR@/../doc/html/*.*")
|
||||
SET(RESOURCE_FILES ${RESOURCE_FILES} ${resource_files_tmp})
|
||||
|
||||
IF(RESOURCE_FILES)
|
||||
FILE(INSTALL FILES ${RESOURCE_FILES} DESTINATION "@CMAKE_INSTALL_FULL_DOCDIR@")
|
||||
ENDIF(RESOURCE_FILES)
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,5 @@
|
||||
<hr class="footer"/><address class="footer"><small>Generated on Tue Jun 26 2012 15:25:54 for Documentation by 
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,59 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<title>Documentation: Home</title>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="openvibe.css" rel="stylesheet" type="text/css"/>
|
||||
</head>
|
||||
<body>
|
||||
<div id="sidebar">
|
||||
<div class="tabs">
|
||||
<ul class="tablist" style="width:100%">
|
||||
<li style="width:100%"><a href="http://openvibe.inria.fr">OpenViBE</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<ul>
|
||||
<h2>Search</h2>
|
||||
<form action="search.php" method="get" id="search">
|
||||
<input class="search" type="text" name="q" placeholder="Quick Search..." />
|
||||
</form>
|
||||
<h2>Doxygen</h2>
|
||||
<ul>
|
||||
<li><a href="modules.html">Modules</a></li>
|
||||
<li><a href="namespaces.html">Namespaces</a></li>
|
||||
<li><a href="classes.html">Class List</a></li>
|
||||
<li><a href="annotated.html">Class Index</a></li>
|
||||
<li><a href="hierarchy.html">Class Hierarchy</a></li>
|
||||
<li><a href="Doc_BoxAlgorithms.html"><b>Box Descriptions</b></a></li>
|
||||
</ul>
|
||||
<h2>Online Manual</h2>
|
||||
<ul>
|
||||
<li><a href="http://openvibe.inria.fr/documentation-index">Documentation Index</a></li>
|
||||
<li><a href="http://openvibe.inria.fr/documentation-index/#User+Documentation">User Documentation</a></li>
|
||||
<li><a href="http://openvibe.inria.fr/documentation-index/#Developer+Documentation">Developer Documentation</a></li>
|
||||
<li><a href="http://openvibe.inria.fr/start">Video Tutorials</a></li>
|
||||
<li><a href="http://openvibe.inria.fr/documentation/">Other versions of this doc</a></li>
|
||||
</ul>
|
||||
<h2>Quick Access</h2>
|
||||
<ul>
|
||||
<li><a href="http://openvibe.inria.fr">OpenViBE Home</a></li>
|
||||
<li><a href="http://openvibe.inria.fr/forum">Forum</a></li>
|
||||
<li><a href="http://gitlab.inria.fr/openvibe">Code Repository</a></li>
|
||||
<li><a href="http://openvibe.inria.fr/tracker">Bugtracker</a></li>
|
||||
</ul>
|
||||
<h2>Contact</h2>
|
||||
<ul>
|
||||
<li><a href="http://openvibe.inria.fr/Contact"><b>Project Contact</b></a></li>
|
||||
</ul>
|
||||
</ul>
|
||||
<div>
|
||||
<p>This documentation is licenced under CC-BY-SA</p>
|
||||
<a href="http://creativecommons.org/licenses/by-sa/3.0/legalcode"><img src="http://openvibe.inria.fr/documentation/unstable/cc-by-sa.png" alt="cc-by-sa"/></a>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div id="top">
|
||||
@@ -0,0 +1,513 @@
|
||||
/**
|
||||
|
||||
\page Doc_Licence Licence
|
||||
|
||||
\section Doc_Licence_Title GNU LESSER GENERAL PUBLIC LICENSE
|
||||
\subsection Doc_Licence_Version Version 2.1, February 1999
|
||||
|
||||
\verbatim
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
\endverbatim
|
||||
|
||||
\subsection Doc_Licence_Preamble Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
\subsection Doc_Licence_Terms GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
\subsection Doc_Licence_Warranty NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
\subsection Doc_Licence_End END OF TERMS AND CONDITIONS
|
||||
|
||||
\subsection Doc_Licence_How How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
\verbatim
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
\endverbatim
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
\verbatim
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
\endverbatim
|
||||
|
||||
That's all there is to it!
|
||||
|
||||
*/
|
||||
@@ -0,0 +1,27 @@
|
||||
REM @ECHO OFF
|
||||
SETLOCAL EnableExtensions
|
||||
|
||||
REM Get the directory location of this script, assume it contains the OpenViBE dist tree. These variables will be used by OpenViBE executables.
|
||||
SET "OV_SOURCE=%1"
|
||||
SET "OV_BUILD=%2"
|
||||
SHIFT
|
||||
SHIFT
|
||||
|
||||
SET "OV_PATH_BIN=%OV_BUILD%\openvibe\"
|
||||
SET "OV_PATH_LIB=%OV_BUILD%\openvibe\;%OV_BUILD%\modules\ebml\;%OV_BUILD%\modules\system\;%OV_BUILD%\modules\fs\;%OV_BUILD%\modules\xml\;%OV_BUILD%\modules\socket\;%OV_BUILD%\modules\automaton\;%OV_BUILD%\toolkit\"
|
||||
SET "OV_PATH_DATA=%OV_BUILD%\share\openvibe"
|
||||
|
||||
SET PATH=%OV_PATH_LIB%;%PATH%
|
||||
|
||||
|
||||
SET "OV_ENVIRONMENT_FILE=%OV_SOURCE%\scripts\win32-dependencies.cmd"
|
||||
IF NOT EXIST "%OV_ENVIRONMENT_FILE%" (
|
||||
ECHO Error: "%OV_ENVIRONMENT_FILE%" was not found
|
||||
GOTO EndOfScript
|
||||
)
|
||||
CALL "%OV_ENVIRONMENT_FILE%"
|
||||
@ECHO ON
|
||||
|
||||
"%OV_BUILD%\applications\developer-tools\plugin-inspector\openvibe-plugin-inspector.exe" %*
|
||||
|
||||
:EndOfScript
|
||||
@@ -0,0 +1,41 @@
|
||||
/**
|
||||
\mainpage Home
|
||||
\section Doc_Preface Preface
|
||||
|
||||
Welcome to the Doxygen Documentation for OpenViBE @PROJECT_VERSION@.
|
||||
|
||||
This document has been automatically generated on Linux. Please note
|
||||
|
||||
- The documentation lacks components and classes that are not compiled on Linux.
|
||||
- Some source files do not have doxygen information and may not be represented here.
|
||||
- Plugins such as boxes and drivers are not included in the class lists to better illustrate the core part of OpenViBE.
|
||||
However, you can see the boxes on the <a href="Doc_BoxAlgorithms.html"><b>Box Descriptions</b></a> page.
|
||||
|
||||
The tutorials and user manual, as well as build instructions for OpenViBE are located on the website : http://openvibe.inria.fr/documentation-index
|
||||
|
||||
\section Doc_Boxes Box Descriptions
|
||||
|
||||
This section contains the description of all of the Boxes available in the OpenViBE Designer.
|
||||
|
||||
- \subpage Doc_BoxAlgorithms
|
||||
|
||||
\subsection Doc_EBML Details on EBML
|
||||
|
||||
OpenViBE uses EBML as a container for all data streams. If you would like to extend the formats of data OpenViBE can handle you might want to document yourself on EBML usage.
|
||||
|
||||
- \subpage Doc_WhatIsEBML
|
||||
- \subpage Doc_ParsingEBMLStreams
|
||||
- \subpage Doc_FormatingEBMLStreams
|
||||
|
||||
\subsection Doc_OngoingDocumentation Ongoing Documentation
|
||||
- \subpage Doc_SoftwareArchitectureOverview (incomplete)
|
||||
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user