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 |
1.1 --- a/.hgignore Thu Sep 08 15:12:56 2016 +0200 1.2 +++ b/.hgignore Thu Sep 08 16:39:45 2016 +0200 1.3 @@ -3,6 +3,6 @@ 1.4 ^build/.*$ 1.5 core$ 1.6 DS_Store$ 1.7 -^doc/.*$ 1.8 +^docs/api/.*$ 1.9 ^.c?project$ 1.10 ^.settings/.*$
2.1 --- a/Doxyfile Thu Sep 08 15:12:56 2016 +0200 2.2 +++ b/Doxyfile Thu Sep 08 16:39:45 2016 +0200 2.3 @@ -58,7 +58,7 @@ 2.4 # entered, it will be relative to the location where doxygen was started. If 2.5 # left blank the current directory will be used. 2.6 2.7 -OUTPUT_DIRECTORY = doc 2.8 +OUTPUT_DIRECTORY = docs/api 2.9 2.10 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 2.11 # directories (in 2 levels) under the output directory of each output format and
3.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 3.2 +++ b/docs/web/examples.html Thu Sep 08 16:39:45 2016 +0200 3.3 @@ -0,0 +1,50 @@ 3.4 +<!DOCTYPE html> 3.5 +<html> 3.6 + <head> 3.7 + <title>UAP Common Extensions</title> 3.8 + <link rel="stylesheet" type="text/css" href="ucx.css"> 3.9 + </head> 3.10 + <body> 3.11 + <!-- begin header --> 3.12 + <div class="header"> 3.13 + <span>UAP Common Extensions</span> 3.14 + <img src="uaplogo.png" alt="UAP Core"> 3.15 + </div> 3.16 + <!-- end header --> 3.17 + 3.18 + <!-- begin navigation --> 3.19 + <div class="sidebar"> 3.20 + <div class="nav"> 3.21 + <h3>Getting Started</h3> 3.22 + <ul> 3.23 + <li><a href="index.html">Overview</a></li> 3.24 + <li><a href="install.html">Build Instructions</a></li> 3.25 + <li><a href="license.html">License</a></li> 3.26 + </ul> 3.27 + </div> 3.28 + <div class="nav"> 3.29 + <h3>Development</h3> 3.30 + <ul> 3.31 + <li><a href="integration.html">Integration</a></li> 3.32 + <li><a href="modules.html">Modules</a></li> 3.33 + <li><a href="examples.html">Examples</a></li> 3.34 + </ul> 3.35 + </div> 3.36 + <div class="nav"> 3.37 + <h3>Resources</h3> 3.38 + <ul> 3.39 + <li><a target="_blank" href="api/">API Reference</a></li> 3.40 + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> 3.41 + </ul> 3.42 + </div> 3.43 + </div> 3.44 + <!-- end navigation --> 3.45 + 3.46 + <!-- begin content --> 3.47 + <div class="content"> 3.48 + <h1>Examples</h1> 3.49 + </div> 3.50 + <!-- end content --> 3.51 + 3.52 + </body> 3.53 +</html>
4.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 4.2 +++ b/docs/web/index.html Thu Sep 08 16:39:45 2016 +0200 4.3 @@ -0,0 +1,50 @@ 4.4 +<!DOCTYPE html> 4.5 +<html> 4.6 + <head> 4.7 + <title>UAP Common Extensions</title> 4.8 + <link rel="stylesheet" type="text/css" href="ucx.css"> 4.9 + </head> 4.10 + <body> 4.11 + <!-- begin header --> 4.12 + <div class="header"> 4.13 + <span>UAP Common Extensions</span> 4.14 + <img src="uaplogo.png" alt="UAP Core"> 4.15 + </div> 4.16 + <!-- end header --> 4.17 + 4.18 + <!-- begin navigation --> 4.19 + <div class="sidebar"> 4.20 + <div class="nav"> 4.21 + <h3>Getting Started</h3> 4.22 + <ul> 4.23 + <li><a href="index.html">Overview</a></li> 4.24 + <li><a href="install.html">Build Instructions</a></li> 4.25 + <li><a href="license.html">License</a></li> 4.26 + </ul> 4.27 + </div> 4.28 + <div class="nav"> 4.29 + <h3>Development</h3> 4.30 + <ul> 4.31 + <li><a href="integration.html">Integration</a></li> 4.32 + <li><a href="modules.html">Modules</a></li> 4.33 + <li><a href="examples.html">Examples</a></li> 4.34 + </ul> 4.35 + </div> 4.36 + <div class="nav"> 4.37 + <h3>Resources</h3> 4.38 + <ul> 4.39 + <li><a target="_blank" href="api/">API Reference</a></li> 4.40 + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> 4.41 + </ul> 4.42 + </div> 4.43 + </div> 4.44 + <!-- end navigation --> 4.45 + 4.46 + <!-- begin content --> 4.47 + <div class="content"> 4.48 + <h1>UAP Common Extensions</h1> 4.49 + </div> 4.50 + <!-- end content --> 4.51 + 4.52 + </body> 4.53 +</html>
5.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 5.2 +++ b/docs/web/install.html Thu Sep 08 16:39:45 2016 +0200 5.3 @@ -0,0 +1,50 @@ 5.4 +<!DOCTYPE html> 5.5 +<html> 5.6 + <head> 5.7 + <title>UAP Common Extensions</title> 5.8 + <link rel="stylesheet" type="text/css" href="ucx.css"> 5.9 + </head> 5.10 + <body> 5.11 + <!-- begin header --> 5.12 + <div class="header"> 5.13 + <span>UAP Common Extensions</span> 5.14 + <img src="uaplogo.png" alt="UAP Core"> 5.15 + </div> 5.16 + <!-- end header --> 5.17 + 5.18 + <!-- begin navigation --> 5.19 + <div class="sidebar"> 5.20 + <div class="nav"> 5.21 + <h3>Getting Started</h3> 5.22 + <ul> 5.23 + <li><a href="index.html">Overview</a></li> 5.24 + <li><a href="install.html">Build Instructions</a></li> 5.25 + <li><a href="license.html">License</a></li> 5.26 + </ul> 5.27 + </div> 5.28 + <div class="nav"> 5.29 + <h3>Development</h3> 5.30 + <ul> 5.31 + <li><a href="integration.html">Integration</a></li> 5.32 + <li><a href="modules.html">Modules</a></li> 5.33 + <li><a href="examples.html">Examples</a></li> 5.34 + </ul> 5.35 + </div> 5.36 + <div class="nav"> 5.37 + <h3>Resources</h3> 5.38 + <ul> 5.39 + <li><a target="_blank" href="api/">API Reference</a></li> 5.40 + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> 5.41 + </ul> 5.42 + </div> 5.43 + </div> 5.44 + <!-- end navigation --> 5.45 + 5.46 + <!-- begin content --> 5.47 + <div class="content"> 5.48 + <h1>Install UCX</h1> 5.49 + </div> 5.50 + <!-- end content --> 5.51 + 5.52 + </body> 5.53 +</html>
6.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 6.2 +++ b/docs/web/integration.html Thu Sep 08 16:39:45 2016 +0200 6.3 @@ -0,0 +1,50 @@ 6.4 +<!DOCTYPE html> 6.5 +<html> 6.6 + <head> 6.7 + <title>UAP Common Extensions</title> 6.8 + <link rel="stylesheet" type="text/css" href="ucx.css"> 6.9 + </head> 6.10 + <body> 6.11 + <!-- begin header --> 6.12 + <div class="header"> 6.13 + <span>UAP Common Extensions</span> 6.14 + <img src="uaplogo.png" alt="UAP Core"> 6.15 + </div> 6.16 + <!-- end header --> 6.17 + 6.18 + <!-- begin navigation --> 6.19 + <div class="sidebar"> 6.20 + <div class="nav"> 6.21 + <h3>Getting Started</h3> 6.22 + <ul> 6.23 + <li><a href="index.html">Overview</a></li> 6.24 + <li><a href="install.html">Build Instructions</a></li> 6.25 + <li><a href="license.html">License</a></li> 6.26 + </ul> 6.27 + </div> 6.28 + <div class="nav"> 6.29 + <h3>Development</h3> 6.30 + <ul> 6.31 + <li><a href="integration.html">Integration</a></li> 6.32 + <li><a href="modules.html">Modules</a></li> 6.33 + <li><a href="examples.html">Examples</a></li> 6.34 + </ul> 6.35 + </div> 6.36 + <div class="nav"> 6.37 + <h3>Resources</h3> 6.38 + <ul> 6.39 + <li><a target="_blank" href="api/">API Reference</a></li> 6.40 + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> 6.41 + </ul> 6.42 + </div> 6.43 + </div> 6.44 + <!-- end navigation --> 6.45 + 6.46 + <!-- begin content --> 6.47 + <div class="content"> 6.48 + <h1>Integrate UCX Into Your Projects</h1> 6.49 + </div> 6.50 + <!-- end content --> 6.51 + 6.52 + </body> 6.53 +</html>
7.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 7.2 +++ b/docs/web/license.html Thu Sep 08 16:39:45 2016 +0200 7.3 @@ -0,0 +1,85 @@ 7.4 +<!DOCTYPE html> 7.5 +<html> 7.6 + <head> 7.7 + <title>UAP Common Extensions</title> 7.8 + <link rel="stylesheet" type="text/css" href="ucx.css"> 7.9 + </head> 7.10 + <body> 7.11 + <!-- begin header --> 7.12 + <div class="header"> 7.13 + <span>UAP Common Extensions</span> 7.14 + <img src="uaplogo.png" alt="UAP Core"> 7.15 + </div> 7.16 + <!-- end header --> 7.17 + 7.18 + <!-- begin navigation --> 7.19 + <div class="sidebar"> 7.20 + <div class="nav"> 7.21 + <h3>Getting Started</h3> 7.22 + <ul> 7.23 + <li><a href="index.html">Overview</a></li> 7.24 + <li><a href="install.html">Build Instructions</a></li> 7.25 + <li><a href="license.html">License</a></li> 7.26 + </ul> 7.27 + </div> 7.28 + <div class="nav"> 7.29 + <h3>Development</h3> 7.30 + <ul> 7.31 + <li><a href="integration.html">Integration</a></li> 7.32 + <li><a href="modules.html">Modules</a></li> 7.33 + <li><a href="examples.html">Examples</a></li> 7.34 + </ul> 7.35 + </div> 7.36 + <div class="nav"> 7.37 + <h3>Resources</h3> 7.38 + <ul> 7.39 + <li><a target="_blank" href="api/">API Reference</a></li> 7.40 + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> 7.41 + </ul> 7.42 + </div> 7.43 + </div> 7.44 + <!-- end navigation --> 7.45 + 7.46 + <!-- begin content --> 7.47 + <div class="content"> 7.48 + <h1>License</h1> 7.49 + <p>Copyright 2016 Olaf Wintermann. All rights reserved.</p> 7.50 + 7.51 + <p> 7.52 + Redistribution and use in source and binary forms, with or 7.53 + without modification, are permitted provided that the following 7.54 + conditions are met: 7.55 + </p> 7.56 + <ol> 7.57 + <li> 7.58 + Redistributions of source code must retain the above 7.59 + copyright notice, this list of conditions and the following 7.60 + disclaimer. 7.61 + </li> 7.62 + <li> 7.63 + Redistributions in binary form must reproduce the above 7.64 + copyright notice, this list of conditions and the following 7.65 + disclaimer in the documentation and/or other materials provided 7.66 + with the distribution. 7.67 + </li> 7.68 + </ol> 7.69 + <p> 7.70 + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 7.71 + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 7.72 + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 7.73 + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 7.74 + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 7.75 + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 7.76 + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 7.77 + NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 7.78 + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 7.79 + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 7.80 + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 7.81 + OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 7.82 + EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 7.83 + </p> 7.84 + </div> 7.85 + <!-- end content --> 7.86 + 7.87 + </body> 7.88 +</html>
8.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 8.2 +++ b/docs/web/modules.html Thu Sep 08 16:39:45 2016 +0200 8.3 @@ -0,0 +1,50 @@ 8.4 +<!DOCTYPE html> 8.5 +<html> 8.6 + <head> 8.7 + <title>UAP Common Extensions</title> 8.8 + <link rel="stylesheet" type="text/css" href="ucx.css"> 8.9 + </head> 8.10 + <body> 8.11 + <!-- begin header --> 8.12 + <div class="header"> 8.13 + <span>UAP Common Extensions</span> 8.14 + <img src="uaplogo.png" alt="UAP Core"> 8.15 + </div> 8.16 + <!-- end header --> 8.17 + 8.18 + <!-- begin navigation --> 8.19 + <div class="sidebar"> 8.20 + <div class="nav"> 8.21 + <h3>Getting Started</h3> 8.22 + <ul> 8.23 + <li><a href="index.html">Overview</a></li> 8.24 + <li><a href="install.html">Build Instructions</a></li> 8.25 + <li><a href="license.html">License</a></li> 8.26 + </ul> 8.27 + </div> 8.28 + <div class="nav"> 8.29 + <h3>Development</h3> 8.30 + <ul> 8.31 + <li><a href="integration.html">Integration</a></li> 8.32 + <li><a href="modules.html">Modules</a></li> 8.33 + <li><a href="examples.html">Examples</a></li> 8.34 + </ul> 8.35 + </div> 8.36 + <div class="nav"> 8.37 + <h3>Resources</h3> 8.38 + <ul> 8.39 + <li><a target="_blank" href="api/">API Reference</a></li> 8.40 + <li><a target="_blank" href="http://develop.uap-core.de/hg/ucx/">Repository</a></li> 8.41 + </ul> 8.42 + </div> 8.43 + </div> 8.44 + <!-- end navigation --> 8.45 + 8.46 + <!-- begin content --> 8.47 + <div class="content"> 8.48 + <h1>Modules</h1> 8.49 + </div> 8.50 + <!-- end content --> 8.51 + 8.52 + </body> 8.53 +</html>
9.1 Binary file docs/web/uaplogo.png has changed
10.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 10.2 +++ b/docs/web/ucx.css Thu Sep 08 16:39:45 2016 +0200 10.3 @@ -0,0 +1,79 @@ 10.4 +.header, h1, h2, h3, .sidebar { 10.5 + font-family: sans-serif; 10.6 +} 10.7 + 10.8 +div.header { 10.9 + padding-top: 0.3em; 10.10 + padding-bottom: 0.5em; 10.11 + margin-bottom: 2em; 10.12 + border: none; 10.13 + border-bottom: 1px solid; 10.14 + border-bottom-color: #2E2E2E; 10.15 +} 10.16 + 10.17 +div.header span { 10.18 + font-size: 2em; 10.19 + font-weight: bold; 10.20 + margin-left: 1em; 10.21 +} 10.22 + 10.23 +div.header img { 10.24 + float: right; 10.25 +} 10.26 + 10.27 +div.sidebar { 10.28 + float: left; 10.29 + width: 15em; 10.30 +} 10.31 + 10.32 +div.nav { 10.33 + color: black; 10.34 + background-color: #E9EBEC; 10.35 + margin-bottom: 1em; 10.36 + padding-bottom: 0.1em; 10.37 +} 10.38 + 10.39 +div.nav h3 { 10.40 + color: white; 10.41 + background-color: #5B6F7A; 10.42 + font-size: 1.2em; 10.43 + padding-top: 0.2em; 10.44 + padding-bottom: 0.2em; 10.45 + padding-left: 0.5em; 10.46 + margin-top: 0; 10.47 +} 10.48 + 10.49 +div.nav ul { 10.50 + margin-top: 0; 10.51 + padding-top: 0; 10.52 + font-size: 0.95em; 10.53 +} 10.54 + 10.55 +div.content { 10.56 + margin-left: 16em; 10.57 + padding: 0; 10.58 + font-family: serif; 10.59 + font-size: 1em; 10.60 + min-width: 16em; 10.61 +} 10.62 + 10.63 +div.content h1 { 10.64 + color: white; 10.65 + background-color: #5B6F7A; 10.66 + font-size: 1.2em; 10.67 + padding-top: 0.2em; 10.68 + padding-bottom: 0.2em; 10.69 + padding-left: 0.5em; 10.70 + padding-right: 0; 10.71 + margin-top: 0; 10.72 +} 10.73 + 10.74 +div.content h2 { 10.75 + font-size: 1.2em; 10.76 +} 10.77 + 10.78 +div.content h3 { 10.79 + font-size: 1.05em; 10.80 +} 10.81 + 10.82 +
