diff options
-rw-r--r-- | docx/CommonAPISpecification (renamed from doc/CommonAPISpecification) | 43 | ||||
-rw-r--r-- | docx/Makefile (renamed from doc/Makefile) | 44 | ||||
-rw-r--r-- | docx/Tutorial (renamed from doc/Tutorial) | 0 | ||||
-rwxr-xr-x | docx/images/CodeGenerationFrancaIDL.png (renamed from doc/images/CodeGenerationFrancaIDL.png) | bin | 11443 -> 11443 bytes | |||
-rwxr-xr-x | docx/images/Deployment.png (renamed from doc/images/Deployment.png) | bin | 14984 -> 14984 bytes | |||
-rwxr-xr-x | docx/images/Diag_Attributes.png (renamed from doc/images/Diag_Attributes.png) | bin | 18429 -> 18429 bytes | |||
-rwxr-xr-x | docx/images/Diag_GeneratedProxy.png (renamed from doc/images/Diag_GeneratedProxy.png) | bin | 16965 -> 16965 bytes | |||
-rwxr-xr-x | docx/images/Diag_GeneratedStub.png (renamed from doc/images/Diag_GeneratedStub.png) | bin | 66369 -> 66369 bytes | |||
-rwxr-xr-x | docx/images/E04PhoneBook.png (renamed from doc/images/E04PhoneBook.png) | bin | 44793 -> 44793 bytes | |||
-rwxr-xr-x | docx/images/E05Manager.png (renamed from doc/images/E05Manager.png) | bin | 25028 -> 25028 bytes | |||
-rwxr-xr-x | docx/images/icons/important.png (renamed from doc/images/icons/important.png) | bin | 3851 -> 3851 bytes | |||
-rw-r--r-- | docx/images/icons/logo.png | bin | 0 -> 6075 bytes | |||
-rw-r--r-- | docx/images/icons/note.png (renamed from doc/images/icons/note.png) | bin | 4049 -> 4049 bytes | |||
-rw-r--r-- | docx/index.html | 23 | ||||
-rw-r--r-- | docx/mainpagetests/01_mainpage.dox (renamed from doc/mainpagetests/01_mainpage.dox) | 0 | ||||
-rw-r--r-- | org.genivi.commonapi.core.verification/doxygen-test.cfg | 2 |
16 files changed, 77 insertions, 35 deletions
diff --git a/doc/CommonAPISpecification b/docx/CommonAPISpecification index 5793b97..d6056d6 100644 --- a/doc/CommonAPISpecification +++ b/docx/CommonAPISpecification @@ -1,38 +1,53 @@ -CommonAPI C++ Specification -=========================== :website: http://projects.genivi.org/commonapi/ :version: -:date: :toc: -:revdate: :imagedir: :cppstr: c++ -This is the specification for *CommonAPI {version}* Revision Date {revdate}. +CommonAPI C++ Specification +=========================== + +This is the specification for *Common API {version}* released at {revdate}. .Copyright and License ******************************************************************************* Copyright (C) 2013, GENIVI Alliance, Inc. Copyright (C) 2013, BMW AG -This file is part of the GENIVI Project IPC Common API C++. +This file is part of the GENIVI IPC Common API C++i project. Contributions are licensed to the GENIVI Alliance under one or more Contribution License Agreements or MPL 2.0. ******************************************************************************* -CommonAPI is a C++ standard API framework for Interprocess Communication (IPC). A specific IPC framework is not included but it can be used with any kind of IPC mechanism if a middleware specific CommonAPI binding is provided. - -Common API allows that applications (i.e., clients and servers using C++) developed against Common API can be linked against different Common API IPC backends without any changes to the application code. Thus, components which have been developed for a system which uses IPC X can be deployed for a system which uses IPC Y easily, just by generating some glue code and rebuilt. The actual interface definitions will be created using http://code.google.com/a/eclipselabs.org/p/franca/[Franca IDL], which is the Common IDL solution favored by http://www.genivi.org/[GENIVI]. - -Common API will not be restricted to GENIVI members (cf. new GENIVI open source policy). It is available as open source code and some code generation tooling (see http://projects.genivi.org/). +IPC Common API is a C++ abstraction framework for *Interprocess Communication* (IPC). +It is supposed to be neutral to IPC implementations and therefore can be used with any +kind of IPC mechanism if a middleware specific _IPC Common API binding_ is provided. + +IPC Common API allows applications (i.e., clients and servers using C++) developed +against IPC Common API to be linked with different IPC Common API _backends_ without +any changes to the application code. +Thus, components which have been developed for a system which uses specific IPC X could +be deployed for another system which uses IPC Y easily - just by exchanging the +IPC Common API backend without recompiling the application code. +The actual interface definitions will be created using +http://code.google.com/a/eclipselabs.org/p/franca/[Franca IDL], which is the +Common IDL solution favored by http://www.genivi.org/[GENIVI]. + +IPC Common API is not restricted to GENIVI members +(see https://www.genivi.org/sites/default/files/genivi_public_newsletter_October_2013_liquid.html#LIC[public GENIVI licensing policy]). +It is available as open source code, which is split into runtime code for the target +system and code generation tooling (see http://projects.genivi.org/) to be used on +development systems. .This document ******************************************************************************** -This document originates from a page in the GENIVI Wiki which was the result of some work of the System Infrastructure Expert Group -for the IPC subdomain. +This document originates from the GENIVI Wiki and was the result of +some work of the IPC subdomain as part of the GENIVI System Infrastructure Expert Group. -If you're new to CommonAPI please read the introduction of this document and the CommonAPI Tutorial which can be found in the http://git.projects.genivi.org/?p=ipc/common-api-tools.git;a=summary[CommonAPI-Tools repository]. +If you're new to IPC Common API please read the introduction of this document and +the IPC Common API Tutorial available at the +http://git.projects.genivi.org/?p=ipc/common-api-tools.git;a=summary[CommonAPI-Tools repository]. ******************************************************************************** General Design diff --git a/doc/Makefile b/docx/Makefile index ac1cbab..3e5a42a 100644 --- a/doc/Makefile +++ b/docx/Makefile @@ -1,17 +1,19 @@ # Creating CommonAPI documentation -docgendir=../doc-gen -iconsdir=../../images/icons -imagedir=../../images -datestring=$(shell date "+%m-%d-%y") +docgendir=../doc +htmldocgendir=$(docgendir)/html +pdfdocgendir=$(docgendir)/pdf +iconsdir=../images/icons +imagedir=../images +datestring=$(shell date "+%d.\ %b\ %Y") verification_project_path=../org.genivi.commonapi.core.verification -commonapi_version=2.1.5 +commonapi_version=$(PROJECT_VERSION) all: doc doc: spec_html spec_pdf tut_html tut_pdf test_html test_pdf spec_html: docgendir - mkdir -p $(docgendir)/spec/html + mkdir -p $(htmldocgendir) asciidoc \ -a revdate=$(datestring) \ -a icons \ @@ -20,11 +22,11 @@ spec_html: docgendir -a version=$(commonapi_version) \ -a cppstr=cpp \ -a tabsize=4 \ - -o $(docgendir)/spec/html/CommonAPISpecification.html \ + -o $(htmldocgendir)/CommonAPISpecification.html \ CommonAPISpecification spec_pdf: docgendir - mkdir -p $(docgendir)/spec/pdf + mkdir -p $(pdfdocgendir) a2x \ -a revdate=$(datestring) \ -a icons \ @@ -35,11 +37,11 @@ spec_pdf: docgendir -f pdf \ --dblatex-opts "-P latex.output.revhistory=0" \ --icons \ - -D $(docgendir)/spec/pdf \ + -D $(pdfdocgendir) \ CommonAPISpecification tut_html: docgendir - mkdir -p $(docgendir)/tutorial/html + mkdir -p $(htmldocgendir) asciidoc -a revdate=$(datestring) \ -a icons \ -a iconsdir=$(iconsdir) \ @@ -48,11 +50,11 @@ tut_html: docgendir -a cppstr=cpp \ -a tabsize=4 \ -b html \ - -o $(docgendir)/tutorial/html/Tutorial.html \ + -o $(htmldocgendir)/Tutorial.html \ Tutorial tut_pdf: docgendir - mkdir -p $(docgendir)/tutorial/pdf + mkdir -p $(pdfdocgendir) a2x \ -a revdate=$(datestring) \ -a icons \ @@ -63,25 +65,27 @@ tut_pdf: docgendir -f pdf \ --dblatex-opts "-P latex.output.revhistory=0 -P imagedata.default.scale=maxwidth=10cm,maxheight=8cm" \ --icons \ - -D $(docgendir)/tutorial/pdf \ + -D $(pdfdocgendir) \ Tutorial test_html: docgendir - mkdir -p $(docgendir)/tests - OUTPUT_DIRECTORY=$(docgendir)/tests \ + mkdir -p $(htmldocgendir)/tests + OUTPUT_DIRECTORY=$(htmldocgendir)/tests \ PROJECT_NAME=CommonAPITests \ - SRC_DIR='$(verification_project_path)/src ../doc/mainpagetests' \ + SRC_DIR='$(verification_project_path)/src ../docx/mainpagetests' \ doxygen $(verification_project_path)/doxygen-test.cfg test_pdf: test_html - cd $(docgendir)/tests/latex; make > /dev/null - mkdir -p $(docgendir)/tests/pdf - cp $(docgendir)/tests/latex/refman.pdf $(docgendir)/tests/pdf/CommonAPITests.pdf - rm -rf $(docgendir)/tests/latex + mkdir -p $(pdfdocgendir)/tests + cd $(htmldocgendir)/tests/latex; make > /dev/null + cd $(htmldocgendir)/tests + cp $(htmldocgendir)/tests/latex/refman.pdf $(pdfdocgendir)/tests/CommonAPITests.pdf + rm -rf $(htmldocgendir)/tests/latex docgendir: mkdir -p $(docgendir) cp -rf images $(docgendir)/images + cp index.html $(docgendir) clean: rm -rf $(docgendir) diff --git a/doc/Tutorial b/docx/Tutorial index 73d7587..73d7587 100644 --- a/doc/Tutorial +++ b/docx/Tutorial diff --git a/doc/images/CodeGenerationFrancaIDL.png b/docx/images/CodeGenerationFrancaIDL.png Binary files differindex f90c135..f90c135 100755 --- a/doc/images/CodeGenerationFrancaIDL.png +++ b/docx/images/CodeGenerationFrancaIDL.png diff --git a/doc/images/Deployment.png b/docx/images/Deployment.png Binary files differindex 16d4404..16d4404 100755 --- a/doc/images/Deployment.png +++ b/docx/images/Deployment.png diff --git a/doc/images/Diag_Attributes.png b/docx/images/Diag_Attributes.png Binary files differindex 36e25f7..36e25f7 100755 --- a/doc/images/Diag_Attributes.png +++ b/docx/images/Diag_Attributes.png diff --git a/doc/images/Diag_GeneratedProxy.png b/docx/images/Diag_GeneratedProxy.png Binary files differindex 2f7fc3b..2f7fc3b 100755 --- a/doc/images/Diag_GeneratedProxy.png +++ b/docx/images/Diag_GeneratedProxy.png diff --git a/doc/images/Diag_GeneratedStub.png b/docx/images/Diag_GeneratedStub.png Binary files differindex 8970c90..8970c90 100755 --- a/doc/images/Diag_GeneratedStub.png +++ b/docx/images/Diag_GeneratedStub.png diff --git a/doc/images/E04PhoneBook.png b/docx/images/E04PhoneBook.png Binary files differindex 5cb2b40..5cb2b40 100755 --- a/doc/images/E04PhoneBook.png +++ b/docx/images/E04PhoneBook.png diff --git a/doc/images/E05Manager.png b/docx/images/E05Manager.png Binary files differindex 1538c0d..1538c0d 100755 --- a/doc/images/E05Manager.png +++ b/docx/images/E05Manager.png diff --git a/doc/images/icons/important.png b/docx/images/icons/important.png Binary files differindex 3148adb..3148adb 100755 --- a/doc/images/icons/important.png +++ b/docx/images/icons/important.png diff --git a/docx/images/icons/logo.png b/docx/images/icons/logo.png Binary files differnew file mode 100644 index 0000000..9b5a475 --- /dev/null +++ b/docx/images/icons/logo.png diff --git a/doc/images/icons/note.png b/docx/images/icons/note.png Binary files differindex 9859d6e..9859d6e 100644 --- a/doc/images/icons/note.png +++ b/docx/images/icons/note.png diff --git a/docx/index.html b/docx/index.html new file mode 100644 index 0000000..8eb743e --- /dev/null +++ b/docx/index.html @@ -0,0 +1,23 @@ +<html><head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>IPC Common API Tools Project Documentation</title> +</head> +<body> +<table width="100%"> +<tbody><tr> +<td> +<a href="http://www.genivi.org/"><img src="images/icons/logo.png" alt="[IPC CommonAPI C++ Tools]"></a></td> +<td valign="bottom"> +<h3 style="font-family:"Trebuchet MS", Helvetica, sans-serif;color:#08669a; ">Documentation for <a href="http://projects.genivi.org/commonapi/" style="text-decoration:none;">IPC Common API C++ Tools Project</a></h3> +</td> +</tr> +</tbody></table> +<br><hr> +<a href="../">IPC Common API C++ index</a> +<br><br> +<TABLE BORDER=1> +<TR BGCOLOR=silver><TH>Document</TH><TH>HTML</TH><TH>PDF</TH></TR> +<TR><TD>Tutorial and examples for IPC Common API C++ usage</TD><TD><a href="html/Tutorial.html">Tutorial (HTML)</a></TD><TD><a href="pdf/Tutorial.pdf">Tutorial (PDF)</a></TD></TR> +<TR><TD>IPC Common API C++ Specification</TD><TD><a href="html/CommonAPISpecification.html">Specification (HTML)</a></TD><TD><a href="pdf/CommonAPISpecification.pdf">Specification (PDF)</a></TD></TR> +<TR><TD>Regression Test Documentation</TD><TD><a href="html/tests/index.html">Test Documentation (HTML)</a></TD><TD><a href="pdf/tests/CommonAPITests.pdf">Test Documentation (PDF)</a></TD></TR> +</TABLE> +</body></html> diff --git a/doc/mainpagetests/01_mainpage.dox b/docx/mainpagetests/01_mainpage.dox index 1cb65df..1cb65df 100644 --- a/doc/mainpagetests/01_mainpage.dox +++ b/docx/mainpagetests/01_mainpage.dox diff --git a/org.genivi.commonapi.core.verification/doxygen-test.cfg b/org.genivi.commonapi.core.verification/doxygen-test.cfg index 09fe94e..4fdc446 100644 --- a/org.genivi.commonapi.core.verification/doxygen-test.cfg +++ b/org.genivi.commonapi.core.verification/doxygen-test.cfg @@ -136,7 +136,7 @@ IGNORE_PREFIX = # Configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES -HTML_OUTPUT = html +HTML_OUTPUT = . HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = |