changeset
adds web documentation to project
Thu, 08 Sep 2016 16:39:45 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Thu, 08 Sep 2016 16:39:45 +0200
- changeset 226
- 669136d4e3af
- parent 225
- a1a068c2c4ef
- child 227
- 740fbd7bab71
adds web documentation to project
| .hgignore | file | annotate | diff | comparison | revisions | |
| Doxyfile | file | annotate | diff | comparison | revisions | |
| docs/web/examples.html | file | annotate | diff | comparison | revisions | |
| docs/web/index.html | file | annotate | diff | comparison | revisions | |
| docs/web/install.html | file | annotate | diff | comparison | revisions | |
| docs/web/integration.html | file | annotate | diff | comparison | revisions | |
| docs/web/license.html | file | annotate | diff | comparison | revisions | |
| docs/web/modules.html | file | annotate | diff | comparison | revisions | |
| docs/web/uaplogo.png | file | annotate | diff | comparison | revisions | |
| docs/web/ucx.css | file | annotate | diff | comparison | revisions |
--- a/.hgignore Thu Sep 08 15:12:56 2016 +0200 +++ b/.hgignore Thu Sep 08 16:39:45 2016 +0200 @@ -3,6 +3,6 @@ ^build/.*$ core$ DS_Store$ -^doc/.*$ +^docs/api/.*$ ^.c?project$ ^.settings/.*$
--- a/Doxyfile Thu Sep 08 15:12:56 2016 +0200 +++ b/Doxyfile Thu Sep 08 16:39:45 2016 +0200 @@ -58,7 +58,7 @@ # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = doc +OUTPUT_DIRECTORY = docs/api # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/web/examples.html Thu Sep 08 16:39:45 2016 +0200 @@ -0,0 +1,50 @@ +<!DOCTYPE html> +<html> + <head> + <title>UAP Common Extensions</title> + <link rel="stylesheet" type="text/css" href="ucx.css"> + </head> + <body> + <!-- begin header --> + <div class="header"> + <span>UAP Common Extensions</span> + <img src="uaplogo.png" alt="UAP Core"> + </div> + <!-- end header --> + + <!-- begin navigation --> + <div class="sidebar"> + <div class="nav"> + <h3>Getting Started</h3> + <ul> + <li><a href="index.html">Overview</a></li> + <li><a href="install.html">Build Instructions</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div class="nav"> + <h3>Development</h3> + <ul> + <li><a href="integration.html">Integration</a></li> + <li><a href="modules.html">Modules</a></li> + <li><a href="examples.html">Examples</a></li> + </ul> + </div> + <div class="nav"> + <h3>Resources</h3> + <ul> + <li><a target="_blank" href="api/">API Reference</a></li> + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> + </ul> + </div> + </div> + <!-- end navigation --> + + <!-- begin content --> + <div class="content"> + <h1>Examples</h1> + </div> + <!-- end content --> + + </body> +</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/web/index.html Thu Sep 08 16:39:45 2016 +0200 @@ -0,0 +1,50 @@ +<!DOCTYPE html> +<html> + <head> + <title>UAP Common Extensions</title> + <link rel="stylesheet" type="text/css" href="ucx.css"> + </head> + <body> + <!-- begin header --> + <div class="header"> + <span>UAP Common Extensions</span> + <img src="uaplogo.png" alt="UAP Core"> + </div> + <!-- end header --> + + <!-- begin navigation --> + <div class="sidebar"> + <div class="nav"> + <h3>Getting Started</h3> + <ul> + <li><a href="index.html">Overview</a></li> + <li><a href="install.html">Build Instructions</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div class="nav"> + <h3>Development</h3> + <ul> + <li><a href="integration.html">Integration</a></li> + <li><a href="modules.html">Modules</a></li> + <li><a href="examples.html">Examples</a></li> + </ul> + </div> + <div class="nav"> + <h3>Resources</h3> + <ul> + <li><a target="_blank" href="api/">API Reference</a></li> + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> + </ul> + </div> + </div> + <!-- end navigation --> + + <!-- begin content --> + <div class="content"> + <h1>UAP Common Extensions</h1> + </div> + <!-- end content --> + + </body> +</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/web/install.html Thu Sep 08 16:39:45 2016 +0200 @@ -0,0 +1,50 @@ +<!DOCTYPE html> +<html> + <head> + <title>UAP Common Extensions</title> + <link rel="stylesheet" type="text/css" href="ucx.css"> + </head> + <body> + <!-- begin header --> + <div class="header"> + <span>UAP Common Extensions</span> + <img src="uaplogo.png" alt="UAP Core"> + </div> + <!-- end header --> + + <!-- begin navigation --> + <div class="sidebar"> + <div class="nav"> + <h3>Getting Started</h3> + <ul> + <li><a href="index.html">Overview</a></li> + <li><a href="install.html">Build Instructions</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div class="nav"> + <h3>Development</h3> + <ul> + <li><a href="integration.html">Integration</a></li> + <li><a href="modules.html">Modules</a></li> + <li><a href="examples.html">Examples</a></li> + </ul> + </div> + <div class="nav"> + <h3>Resources</h3> + <ul> + <li><a target="_blank" href="api/">API Reference</a></li> + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> + </ul> + </div> + </div> + <!-- end navigation --> + + <!-- begin content --> + <div class="content"> + <h1>Install UCX</h1> + </div> + <!-- end content --> + + </body> +</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/web/integration.html Thu Sep 08 16:39:45 2016 +0200 @@ -0,0 +1,50 @@ +<!DOCTYPE html> +<html> + <head> + <title>UAP Common Extensions</title> + <link rel="stylesheet" type="text/css" href="ucx.css"> + </head> + <body> + <!-- begin header --> + <div class="header"> + <span>UAP Common Extensions</span> + <img src="uaplogo.png" alt="UAP Core"> + </div> + <!-- end header --> + + <!-- begin navigation --> + <div class="sidebar"> + <div class="nav"> + <h3>Getting Started</h3> + <ul> + <li><a href="index.html">Overview</a></li> + <li><a href="install.html">Build Instructions</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div class="nav"> + <h3>Development</h3> + <ul> + <li><a href="integration.html">Integration</a></li> + <li><a href="modules.html">Modules</a></li> + <li><a href="examples.html">Examples</a></li> + </ul> + </div> + <div class="nav"> + <h3>Resources</h3> + <ul> + <li><a target="_blank" href="api/">API Reference</a></li> + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> + </ul> + </div> + </div> + <!-- end navigation --> + + <!-- begin content --> + <div class="content"> + <h1>Integrate UCX Into Your Projects</h1> + </div> + <!-- end content --> + + </body> +</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/web/license.html Thu Sep 08 16:39:45 2016 +0200 @@ -0,0 +1,85 @@ +<!DOCTYPE html> +<html> + <head> + <title>UAP Common Extensions</title> + <link rel="stylesheet" type="text/css" href="ucx.css"> + </head> + <body> + <!-- begin header --> + <div class="header"> + <span>UAP Common Extensions</span> + <img src="uaplogo.png" alt="UAP Core"> + </div> + <!-- end header --> + + <!-- begin navigation --> + <div class="sidebar"> + <div class="nav"> + <h3>Getting Started</h3> + <ul> + <li><a href="index.html">Overview</a></li> + <li><a href="install.html">Build Instructions</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div class="nav"> + <h3>Development</h3> + <ul> + <li><a href="integration.html">Integration</a></li> + <li><a href="modules.html">Modules</a></li> + <li><a href="examples.html">Examples</a></li> + </ul> + </div> + <div class="nav"> + <h3>Resources</h3> + <ul> + <li><a target="_blank" href="api/">API Reference</a></li> + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> + </ul> + </div> + </div> + <!-- end navigation --> + + <!-- begin content --> + <div class="content"> + <h1>License</h1> + <p>Copyright 2016 Olaf Wintermann. All rights reserved.</p> + + <p> + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + </p> + <ol> + <li> + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + </li> + <li> + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + </li> + </ol> + <p> + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, + EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + </p> + </div> + <!-- end content --> + + </body> +</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/web/modules.html Thu Sep 08 16:39:45 2016 +0200 @@ -0,0 +1,50 @@ +<!DOCTYPE html> +<html> + <head> + <title>UAP Common Extensions</title> + <link rel="stylesheet" type="text/css" href="ucx.css"> + </head> + <body> + <!-- begin header --> + <div class="header"> + <span>UAP Common Extensions</span> + <img src="uaplogo.png" alt="UAP Core"> + </div> + <!-- end header --> + + <!-- begin navigation --> + <div class="sidebar"> + <div class="nav"> + <h3>Getting Started</h3> + <ul> + <li><a href="index.html">Overview</a></li> + <li><a href="install.html">Build Instructions</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div class="nav"> + <h3>Development</h3> + <ul> + <li><a href="integration.html">Integration</a></li> + <li><a href="modules.html">Modules</a></li> + <li><a href="examples.html">Examples</a></li> + </ul> + </div> + <div class="nav"> + <h3>Resources</h3> + <ul> + <li><a target="_blank" href="api/">API Reference</a></li> + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> + </ul> + </div> + </div> + <!-- end navigation --> + + <!-- begin content --> + <div class="content"> + <h1>Modules</h1> + </div> + <!-- end content --> + + </body> +</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/web/ucx.css Thu Sep 08 16:39:45 2016 +0200 @@ -0,0 +1,79 @@ +.header, h1, h2, h3, .sidebar { + font-family: sans-serif; +} + +div.header { + padding-top: 0.3em; + padding-bottom: 0.5em; + margin-bottom: 2em; + border: none; + border-bottom: 1px solid; + border-bottom-color: #2E2E2E; +} + +div.header span { + font-size: 2em; + font-weight: bold; + margin-left: 1em; +} + +div.header img { + float: right; +} + +div.sidebar { + float: left; + width: 15em; +} + +div.nav { + color: black; + background-color: #E9EBEC; + margin-bottom: 1em; + padding-bottom: 0.1em; +} + +div.nav h3 { + color: white; + background-color: #5B6F7A; + font-size: 1.2em; + padding-top: 0.2em; + padding-bottom: 0.2em; + padding-left: 0.5em; + margin-top: 0; +} + +div.nav ul { + margin-top: 0; + padding-top: 0; + font-size: 0.95em; +} + +div.content { + margin-left: 16em; + padding: 0; + font-family: serif; + font-size: 1em; + min-width: 16em; +} + +div.content h1 { + color: white; + background-color: #5B6F7A; + font-size: 1.2em; + padding-top: 0.2em; + padding-bottom: 0.2em; + padding-left: 0.5em; + padding-right: 0; + margin-top: 0; +} + +div.content h2 { + font-size: 1.2em; +} + +div.content h3 { + font-size: 1.05em; +} + +
