summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElisey Zamakhov <EZamakhov@luxoft.com>2016-08-12 12:30:08 +0300
committerElisey Zamakhov <EZamakhov@luxoft.com>2016-11-22 18:07:02 +0200
commite5f68137747a4bc776ca2c925bd356aecdbc7fe6 (patch)
tree895d26eb16abd1a908273495de4ba9b20b561a50
parent9b2297b9bb2e9851e13a64f18c6ee0737e71b54c (diff)
downloadsdl_core-e5f68137747a4bc776ca2c925bd356aecdbc7fe6.tar.gz
Remove legacy doxygen files
Related issue: APPLINK-25051
-rw-r--r--src/components/policy/doc/doxygen/components/AppMgr/index.txt5
-rw-r--r--src/components/policy/doc/doxygen/components/HMI/index.txt5
-rw-r--r--src/components/policy/doc/doxygen/components/JSONHandler/Formatters/index.txt9
-rw-r--r--src/components/policy/doc/doxygen/components/JSONHandler/index.txt8
-rw-r--r--src/components/policy/doc/doxygen/components/ProtocolHandler/index.txt5
-rw-r--r--src/components/policy/doc/doxygen/components/SmartObjects/index.txt11
-rw-r--r--src/components/policy/doc/doxygen/components/TransportManager/index.txt9
-rw-r--r--src/components/policy/doc/doxygen/components/index.txt10
-rw-r--r--src/components/policy/doc/doxygen/info.txt5
-rw-r--r--src/components/policy/doc/doxygen/mainpage.txt9
-rw-r--r--src/components/policy/doc/doxygen/tools/InterfaceGenerator/Arhitecture.txt5
-rw-r--r--src/components/policy/doc/doxygen/tools/InterfaceGenerator/index.txt12
-rw-r--r--src/components/policy/doc/doxygen/tools/index.txt5
-rw-r--r--src/components/policy/doc/grc/conf.smartDeviceLinkCore34
-rw-r--r--src/components/policy/doc/grc/grc.conf3
-rw-r--r--src/components/policy/doc/install.txt91
-rw-r--r--src/components/policy/doc/qnx_build.txt28
-rw-r--r--src/components/policy/doc/readme.txt66
18 files changed, 0 insertions, 320 deletions
diff --git a/src/components/policy/doc/doxygen/components/AppMgr/index.txt b/src/components/policy/doc/doxygen/components/AppMgr/index.txt
deleted file mode 100644
index 17584b09e1..0000000000
--- a/src/components/policy/doc/doxygen/components/AppMgr/index.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-/*! \page components_appmgr App Manager
-
-Here will be information about App Manager component
-
-*/ \ No newline at end of file
diff --git a/src/components/policy/doc/doxygen/components/HMI/index.txt b/src/components/policy/doc/doxygen/components/HMI/index.txt
deleted file mode 100644
index 361763118d..0000000000
--- a/src/components/policy/doc/doxygen/components/HMI/index.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-/*! \page components_hmi HMI
-
-Here will be information about HMI component
-
-*/ \ No newline at end of file
diff --git a/src/components/policy/doc/doxygen/components/JSONHandler/Formatters/index.txt b/src/components/policy/doc/doxygen/components/JSONHandler/Formatters/index.txt
deleted file mode 100644
index 9854b88d5f..0000000000
--- a/src/components/policy/doc/doxygen/components/JSONHandler/Formatters/index.txt
+++ /dev/null
@@ -1,9 +0,0 @@
-/*! \page components_jsonhandler_formatters Smart Objects Formatters
-
-In order to create JSON string representation from Smart Object or create Smart Object data structure from JSON string representation JSON Handler component has special classes called formatters.
-
-The interface of formatter is quite simple and defined by NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase class. Actually it has two methods - NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase::objToJsonValue to convert JSON string to object and NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase::jsonValueToObj to create JSON string from object.
-
-Current implementation has two different implementations of NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase class: NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonALRPCv1 for ALRPC.v1 and NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonALRPCv2 for ALRPC.v2. These implementations handle specifics of each format.
-
-*/
diff --git a/src/components/policy/doc/doxygen/components/JSONHandler/index.txt b/src/components/policy/doc/doxygen/components/JSONHandler/index.txt
deleted file mode 100644
index a65c8ddc7d..0000000000
--- a/src/components/policy/doc/doxygen/components/JSONHandler/index.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-/*! \page components_jsonhandler JSON Handler
-
-Here will be information about JSON Handler component
-
-Detailed information:
- - \subpage components_jsonhandler_formatters "Smart Objects Formatters"
-
-*/
diff --git a/src/components/policy/doc/doxygen/components/ProtocolHandler/index.txt b/src/components/policy/doc/doxygen/components/ProtocolHandler/index.txt
deleted file mode 100644
index c5b5ceb79c..0000000000
--- a/src/components/policy/doc/doxygen/components/ProtocolHandler/index.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-/*! \page components_protocolhandler Protocol Handler
-
-Here will be information about Protocol Handler component
-
-*/ \ No newline at end of file
diff --git a/src/components/policy/doc/doxygen/components/SmartObjects/index.txt b/src/components/policy/doc/doxygen/components/SmartObjects/index.txt
deleted file mode 100644
index 3844e1ab69..0000000000
--- a/src/components/policy/doc/doxygen/components/SmartObjects/index.txt
+++ /dev/null
@@ -1,11 +0,0 @@
-/*! \page components_smartobjects Smart Objects
-
-Smart Object is building block for a custom dynamic data structures with virtually unlimited complexity. Client code can use Smart Objects to create containers for simple basic types such as bools, ints, doubles, chars, strings end enums as well as arrays and maps.
-
-Smart Objects solution also includes validation/normalization mechanism of schemas witch is similar to the XML schemas. This feature allows client to validate any data structure.
-
-More detailed information is described in following chapters:
- - \subpage components_smartobjects_types "Smart Objects Types"
- - \subpage components_smartobjects_usage "Use of Smart Objects"
- - \subpage components_smartobjects_validation "Smart Objects validation"
-*/
diff --git a/src/components/policy/doc/doxygen/components/TransportManager/index.txt b/src/components/policy/doc/doxygen/components/TransportManager/index.txt
deleted file mode 100644
index 73252c751c..0000000000
--- a/src/components/policy/doc/doxygen/components/TransportManager/index.txt
+++ /dev/null
@@ -1,9 +0,0 @@
-/*! \page components_transportmanager Transport Manager
-
-Transport Manager is a component of SmartDeviceLink application which is designed to provide transparent access to transport layer for other components. Current implementation provides unified access to connections via Bluetooth and TCP. Also this component allows run automatic device discovery and provides information about found devices which is able to connect to SmartDeviceLink.
-
-More detailed information is described in following chapters:
- - \subpage components_transportmanager_client "Transport Manager Client Specification"
- - \subpage components_transportmanager_internal_design "Component Internal Design"
- - \subpage components_transportmanager_use_cases "High-Level Use Cases to Test Component"
-*/
diff --git a/src/components/policy/doc/doxygen/components/index.txt b/src/components/policy/doc/doxygen/components/index.txt
deleted file mode 100644
index 186de88af0..0000000000
--- a/src/components/policy/doc/doxygen/components/index.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-/*! \page components Components
-
-Project contain following components:
- - \subpage components_transportmanager "Transport Manager"
- - \subpage components_protocolhandler "Protocol Handler"
- - \subpage components_jsonhandler "JSON Handler"
- - \subpage components_smartobjects "Smart Objects"
- - \subpage components_appmgr "App Manager"
- - \subpage components_hmi "HMI"
-*/
diff --git a/src/components/policy/doc/doxygen/info.txt b/src/components/policy/doc/doxygen/info.txt
deleted file mode 100644
index e8afe55c12..0000000000
--- a/src/components/policy/doc/doxygen/info.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-/*! \page info Project information
-
-Here will be general information about project
-
-*/ \ No newline at end of file
diff --git a/src/components/policy/doc/doxygen/mainpage.txt b/src/components/policy/doc/doxygen/mainpage.txt
deleted file mode 100644
index 5cd05e2606..0000000000
--- a/src/components/policy/doc/doxygen/mainpage.txt
+++ /dev/null
@@ -1,9 +0,0 @@
-/*! \mainpage Project SmartDeviceLink
-
-This is the entry point to the documentation about project.
-
-This manual is divided in the following sections:
-- \subpage info "General project information"
-- \subpage components "Project components"
-- \subpage tools "Project specific tools"
-*/
diff --git a/src/components/policy/doc/doxygen/tools/InterfaceGenerator/Arhitecture.txt b/src/components/policy/doc/doxygen/tools/InterfaceGenerator/Arhitecture.txt
deleted file mode 100644
index 4cf9e84d99..0000000000
--- a/src/components/policy/doc/doxygen/tools/InterfaceGenerator/Arhitecture.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-/*! \page tools_interfacegenerator_architecture InterfaceGenerator architecture
-
-InterfaceGenerator is designed as flexible and easily expendable tool that allows to implement both new parsers and generators independently. The core idea of InterfaceGenerator that it has middle-ware product - abstract model of interface that should be generated. This middle layer allows to separate collection of parsers from generators. Also it is possible to add any new validation / normalization component between them. So at the moment the root script creates actual parser and that parser produces model of interface (set of Python classes objects). After that interface model is passed to the desired generator and generator creates result source code files.
-
-*/
diff --git a/src/components/policy/doc/doxygen/tools/InterfaceGenerator/index.txt b/src/components/policy/doc/doxygen/tools/InterfaceGenerator/index.txt
deleted file mode 100644
index 21b437f6b7..0000000000
--- a/src/components/policy/doc/doxygen/tools/InterfaceGenerator/index.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-/*! \page tools_interfacegenerator InterfaceGenerator
-
-InterfaceGenerator is a special code generation tool that allows creating of C++ source code to work with interface described as XML file.
-InterfaceGenerator is a bundle of Python scripts. Root script is a Generator.py. This script should be used by the client to run generator.
-Currently InterfaceGenerator supports generation form ALRPC v.1 and ALRPC v.2 XML formats.
-
-For more details please review:
- - \subpage tools_interfacegenerator_usage "How to use InterfaceGenerator"
- - \subpage tools_interfacegenerator_output "Use of InterfaceGenerator output"
- - \subpage tools_interfacegenerator_architecture "InterfaceGenerator architecture"
- - \subpage tools_interfacegenerator_cmakeintegration "Integration with CMake"
-*/
diff --git a/src/components/policy/doc/doxygen/tools/index.txt b/src/components/policy/doc/doxygen/tools/index.txt
deleted file mode 100644
index 4befa33e8d..0000000000
--- a/src/components/policy/doc/doxygen/tools/index.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-/*! \page tools Tools
-
-Project uses following special tools:
- - \subpage tools_interfacegenerator "InterfaceGenerator"
-*/
diff --git a/src/components/policy/doc/grc/conf.smartDeviceLinkCore b/src/components/policy/doc/grc/conf.smartDeviceLinkCore
deleted file mode 100644
index 11c7643c68..0000000000
--- a/src/components/policy/doc/grc/conf.smartDeviceLinkCore
+++ /dev/null
@@ -1,34 +0,0 @@
-# source filename
-regexp=\w+\.(?:cpp|h)
-colours=yellow
-===
-regexp=^(ERROR|FATAL)
-colours=red on_yellow
-===
-regexp=^WARN
-colours=red
-===
-regexp=^INFO
-colours=blue
-===
-regexp=^TRACE
-colours=magenta
-===
-# component
-regexp=(?<=\])\[[^]]+\]
-colours=cyan
-===
-# something invalid
-regexp=(?i)invalid
-colours=red
-===
-# RPC message start
-regexp=^\{$
-colours=bold
-count=block
-===
-# RPC message end
-regexp=^\}$
-colours=bold
-count=unblock
-
diff --git a/src/components/policy/doc/grc/grc.conf b/src/components/policy/doc/grc/grc.conf
deleted file mode 100644
index dfd3d4cbef..0000000000
--- a/src/components/policy/doc/grc/grc.conf
+++ /dev/null
@@ -1,3 +0,0 @@
-# smartDeviceCore command
-(^|[/\w\.]+/)smartDeviceLinkCore\s?
-conf.smartDeviceLinkCore
diff --git a/src/components/policy/doc/install.txt b/src/components/policy/doc/install.txt
deleted file mode 100644
index 8076f427bc..0000000000
--- a/src/components/policy/doc/install.txt
+++ /dev/null
@@ -1,91 +0,0 @@
-* Introduction
- ================
- smartDeviceLinkCore is an application which manages the transport, connection and communication between a head unit and mobile device.
-
-* OS and Hardware
- =========
- Ubuntu 12.04.01 LTS 32-bit OS on the PC with USB-dongle
- Application has been tested using 2 types of USB-dongle:
- D-Link DBT-122
- STLab B-121mini
-
-* External components
- ===================
- For build application we need:
- libbluetooth3, the BlueZ library
- libbluetooth-dev, the development files to link to the BluetZ library.
- Install libraries:
- sudo apt-get install libbluetooth3
- sudo apt-get install libbluetooth-dev
-
- We are using cmake to create build configurations.
- Install cmake:
- sudo apt-get install cmake
-
- Also, make sure the g++ compiler is installed:
- sudo apt-get install g++
-
- To start web-based HMI we need web-browser with web-socket RFC6455 support.
- For example Google Chromium. Install it using:
- sudo apt-get install chromium-browser
-
- To run InterfaceGenerator some python libraries are required and must be
- installed with following command:
- sudo pip install -r tools/InterfaceGenerator/requirements.txt
-
- For logging Apache log4cxx library is used. Install required packages with the following command:
- sudo apt-get install liblog4cxx10 liblog4cxx10-dev
-
- For installing pulseaudio development files which neededfor audio management fetures run:
- sudo apt-get install libpulse-dev
-
- For installing gstreamer development files which needed for audio management fetures:
- First add gstreamer repositories to your apt source list (/etc/apt/sources.list):
- deb http://ppa.launchpad.net/gstreamer-developers/ppa/ubuntu <distributive codename> main
- deb-src http://ppa.launchpad.net/gstreamer-developers/ppa/ubuntu <distributive codename> main
- use code name relevant to the Ubuntu version which you use instead of <distributive codename>.
- Run:
- sudo apt-get update
- and:
- sudo apt-get install gstreamer1.0*
-
-* Build application
- =================
- We support "out of sources" concept for build from R3.0.0
- It means all generated by build tools files will be stored in separate folder.
- Temporary build of application requires two steps.
- 1. Enter src/thirdPartyLibs/logger
- build logger:
-
- 1. Create directory outside of SmartDeviceLink project directory.
- For example "build" folder in the same folder with SmartDeviceLink git repo folder which has a name "git_repo":
- You will have folders structure like this:
- /home/projects/smart_device_link
- |--build
- |--git_repo
- |--doc
- |--src
- |--test
- |--DoxyFile
- \--CMakeLists.txt
- Enter this folder:
- cd build
-
- 2. Create build configuration using cmake:
- 2.1 For Debug configuration
- cmake ../git_repo
- 2.2 For Release configuration, run:
- cmake -DCMAKE_BUILD_TYPE=Release ../git_repo
- 2.3 For Debug configuration with tests, run:
- cmake -DBUILD_TESTS=On ../git_repo
-
- 3. Make project:
- make
-
- Ready to use release application will be in build/src/appMain/smartDeviceLinkCore
-
- 4. If You built configuration with tests (see 2.3 above), then You can run all project tests and see overall result with:
- make test
-
- 5. For creating the doxygen documentation run:
- make doxygen
diff --git a/src/components/policy/doc/qnx_build.txt b/src/components/policy/doc/qnx_build.txt
deleted file mode 100644
index 4f67d6eed3..0000000000
--- a/src/components/policy/doc/qnx_build.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-Building the project
-cmake -DCMAKE_TOOLCHAIN_FILE=../applink/qnx_6.5.0_linux_x86.cmake ../applink
-or for Momentics project:
-cmake -DCMAKE_TOOLCHAIN_FILE=../applink/qnx_6.5.0_linux_x86.cmake -G "Eclipse CDT4 - Unix Makefiles" ../applink
-
-Building with support D-Bus and Qt 4.8
-Install D-Bus (see https://adc.luxoft.com/confluence/x/0AHJDw)
-Install Qt 4.8 (see https://adc.luxoft.com/confluence/x/UwfJDw)
-cmake -DHMI2=ON -DCMAKE_TOOLCHAIN_FILE=../applink/qnx_6.5.0_linux_x86.cmake ../applink
-or for Momentics project:
-cmake -DHMI2=ON -DCMAKE_TOOLCHAIN_FILE=../applink/qnx_6.5.0_linux_x86.cmake -G "Eclipse CDT4 - Unix Makefiles" ../applink
-
-make
-make install
-
-Running project:
-Change server IP in configuration file to QNX target IP.
-Copy directory bin to QNX target.
-You can copy it using scp. Example:
-scp -r user_name@linux_pc_ip:/full_path/to/dir .
-
-For Web HMI set target IP in ini file and change target IP in src/components/HMI/ffw/RPCClient.js
-! Currently we don't have any configuration file for HMI.
-
-Execute smartDeviceLinkCore on QNX qtarget.
-Execute HMI on Linux PC (only Web HMI).
-
-Have fun!
diff --git a/src/components/policy/doc/readme.txt b/src/components/policy/doc/readme.txt
deleted file mode 100644
index f80aed0ffd..0000000000
--- a/src/components/policy/doc/readme.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-* Introduction
- ================
- smartDeviceCore is an application which manages the transport, connection and communication between a head unit and mobile device.
-
-* OS and Hardware
- =========
- Ubuntu 12.04.1 LTS 32-bit OS on the PC with USB-dongle
- Application has been tested using 2 types of USB-dongle:
- D-Link DBT-122
- STLab B-121mini
-
- * External components
- ===================
- For start application we need:
- libbluetooth3, the BlueZ library
- Install library:
- sudo apt-get install libbluetooth3
- To start web-based HMI we need web-browser with web-socket RFC6455 support.
- For example Google Chromium. Install it using:
- sudo apt-get install chromium-browser
- In current implementation Chromium is required for autostart HMI feature.
- For HMI autostart please set path to hmi in config file
- For example:
- LinkToWebHMI = ${path_to_HMI_repository}/index.html
-
-* Running application
- ====================
- Plug USB-dongle in.
- Switch Bluetooth on a mobile device ON and make the device discoverable.
- Pair mobile device with PC using Ubuntu tools.
- Device should contain SmartDeviceLink compatible application installed.
- Start application with command:
- ./smartDeviceLinkCore
- Application starts to search devices and starts HMI in cromium-browser.
- In case HMI has not been started please start web-based HMI manually in browser opening src/components/HMI/index.html.
- SmartDeviceLinkCore is searching Bluetooth devices with a correspondibg service.
- Go to info menu in HMI and press App button.
- Press change Devices button.
- Select the device from a list.
- Application opens all available ports on devices and starts communication.
- Returning to the App menu all applications will be shown in a list.
-
-* Colorized logs
- ==============
- You can have colorized log output of smartDeviceLinkCore's messages in the terminal with the help of grc:
-
- 1. Make sure grc is installed:
- sudo apt-get install grc
-
- 2. Copy the config files from the grc/ directory into ~/.grc/ directory:
- mkdir ~/.grc
- cp grc/* ~/.grc/
-
- 3. Add an alias to your shell's config (usually, ~/.bashrc or ~/.zshrc):
- alias grca='grc -es --colour=auto'
-
- Either restart the shell session or source the edited file:
- source ~/.bashrc
- or
- source ~/.zshrc
-
- 4. Start the smartDeviceLink core with the following command:
- grca ./smartDeviceLinkCore
-
- 5. PROFIT
-