Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Commit

Permalink
Version 1.1.1
Browse files Browse the repository at this point in the history
CHANGELOG
- DOC: Documentation for ReadTheDoc
- FIX: Stop session issue on retry
  • Loading branch information
xlz-jpponcelet committed Nov 7, 2018
1 parent 4ff7ae6 commit cef6dc5
Show file tree
Hide file tree
Showing 14 changed files with 263 additions and 24 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
* Wed Nov 07 2018 Accelize v1.1.1
- DOC: Documentation for ReadTheDoc
- FIX: Stop session issue on retry

* Mon Oct 08 2018 Accelize v1.1.0
- NEW: MeteringSessionManager robustness to network disconnections

Expand Down
29 changes: 28 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ cmake_minimum_required (VERSION 2.8.12)

project(accelize/drmlib)

if(COVERAGE)
include(release-tools/cmake/codecoverage.cmake)
endif()

# Build Type
set(default_build_type "RelWithDebInfo")
if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
Expand Down Expand Up @@ -136,6 +140,25 @@ install(DIRECTORY ${CMAKE_BINARY_DIR}/include/ DESTINATION ${CMAKE_INSTALL_INCLU
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR}/licenses COMPONENT licenses)
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/third-party-licenses/ DESTINATION ${CMAKE_INSTALL_DOCDIR}/licenses/third-party-licenses/ COMPONENT licenses)

message("CMAKE_BINARY_DIR is ${CMAKE_BINARY_DIR}")
message("CMAKE_CURRENT_SOURCE_DIR is ${CMAKE_CURRENT_SOURCE_DIR}")

# Code coverage
option(COVERAGE "Activate code coverage" OFF)
if(COVERAGE)
get_filename_component(_coverage_path ${CMAKE_BINARY_DIR} DIRECTORY)

APPEND_COVERAGE_FLAGS()
# Install coverage information (.gcno) and objects files generated by compiler
install(DIRECTORY ${CMAKE_BINARY_DIR}/CMakeFiles DESTINATION build_coverage/build/${CMAKE_BINARY_DIR}/ COMPONENT coverage)

# Install sources
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/drm_controller_sdk DESTINATION build_coverage/src/${CMAKE_CURRENT_SOURCE_DIR}/ COMPONENT coverage)
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include DESTINATION build_coverage/src/${CMAKE_CURRENT_SOURCE_DIR}/ COMPONENT coverage)
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/internal_inc DESTINATION build_coverage/src/${CMAKE_CURRENT_SOURCE_DIR}/ COMPONENT coverage)
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/source DESTINATION build_coverage/src/${CMAKE_CURRENT_SOURCE_DIR}/ COMPONENT coverage)
endif(COVERAGE)

# Documentation
option(DOC "Produce documentation" OFF)
if(DOC)
Expand All @@ -155,7 +178,7 @@ endif(DOC)

# Packages
set(CPACK_GENERATOR "TGZ;RPM")
set(CPACK_PACKAGE_NAME "libaccelize_drm")
set(CPACK_PACKAGE_NAME "libaccelize_drm${PACKAGE_NAME_SUFFIX}")
set(CPACK_PACKAGE_VENDOR "Accelize")
set(CPACK_PACKAGE_CONTACT "accelize.com")
set(CPACK_PACKAGE_MAINTAINER "accelize.com")
Expand All @@ -177,3 +200,7 @@ cpack_add_component(libraries GROUP devel)
cpack_add_component(headers GROUP devel)
cpack_add_component(doc GROUP devel)
cpack_add_component(licenses GROUP devel)

if(COVERAGE)
cpack_add_component(coverage GROUP devel)
endif()
1 change: 1 addition & 0 deletions doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ FULL_PATH_NAMES=YES
STRIP_FROM_PATH=@CMAKE_BINARY_DIR@
STRIP_FROM_INC_PATH=@CMAKE_BINARY_DIR@/include
GENERATE_LATEX=NO
GENERATE_XML=YES
16 changes: 16 additions & 0 deletions doc/_static/accelize.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.wy-side-nav-search {
background-image: url("background.png");
background-repeat: no-repeat;
background-size: contain;
background-position: top;
background-color: #ea7222
}

.wy-side-nav-search input[type="text"] {
border-color: #ea7222
}

.wy-side-nav-search > a, .wy-side-nav-search .wy-dropdown > a {
color: #ea7222
}

Binary file added doc/_static/accelize_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/background.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/favicon.ico
Binary file not shown.
Binary file added doc/_static/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions doc/c_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
C API
=====

Files
-----

common.h
~~~~~~~~

.. doxygenfile:: drmc/common.h
:project: drmlib


errorcode.h
~~~~~~~~~~~

.. doxygenfile:: drmc/errorcode.h
:project: drmlib


metering.h
~~~~~~~~~~

.. doxygenfile:: drmc/metering.h
:project: drmlib


version.h
~~~~~~~~~

.. doxygenfile:: drmc/version.h
:project: drmlib

85 changes: 85 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# -*- coding: utf-8 -*-
"""Sphinx documentation """

# -- Path setup --------------------------------------------------------------

import os
import subprocess
from os.path import abspath, dirname
import sys



# -- Project information -----------------------------------------------------

project = "drmlib"
copyright = "Accelize"
author = "[email protected]"
version = "v1.1"
release = "v1.1"


sys.path.append( "/home/me/docproj/ext/breathe/" )


read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'

if read_the_docs_build:

subprocess.call('pip install breathe', shell=True)
subprocess.call('doxygen Doxyfile.in', shell=True)

breathe_projects = {
"drmlib":"xml/"
}

extensions = [ 'breathe']

source_suffix = '.rst'
master_doc = 'index'
language = 'en'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.settings']
pygments_style = 'default'


# -- Options for HTML output -------------------------------------------------


html_theme = 'sphinx_rtd_theme'

html_favicon = '_static/favicon.ico'

html_context = {
'css_files': ['_static/accelize.css'], # Overwrite them style
}

html_logo = '_static/logo.png'

html_show_sourcelink = False

html_show_sphinx = False

# -- Options for HTMLHelp output ---------------------------------------------

htmlhelp_basename = '%sdoc' % project

# -- Options for LaTeX output ------------------------------------------------

latex_elements = {}
latex_documents = [(
master_doc, '%s.tex' % project, '%s Documentation' % project, author,
'manual')]

latex_logo = '_static/logo.png'
# -- Options for manual page output ------------------------------------------

man_pages = [(
master_doc, "my_name", '%s Documentation' % project,
[author], 1)]


# -- Options for Texinfo output ----------------------------------------------

texinfo_documents = [(
master_doc, project, '%s Documentation' % project, author, project,
"my_description", 'Miscellaneous')]
46 changes: 46 additions & 0 deletions doc/cpp_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
C++ API
=======

Namespaces
----------

.. doxygennamespace:: Accelize::DRMLib
:project: drmlib
:undoc-members:


Classes
-------

.. doxygenclass:: Accelize::DRMLib::MeteringSessionManager
:project: drmlib


.. doxygenclass:: Accelize::DRMLib::Exception
:project: drmlib


Files
-----

session_manager.h
~~~~~~~~~~~~~~~~~

.. doxygenfile:: drm/session_manager.h
:project: drmlib



error.h
~~~~~~~

.. doxygenfile:: drm/error.h
:project: drmlib


version.h
~~~~~~~~~

.. .. doxygenfile:: drm/version.h
.. :project: drmlib
9 changes: 9 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
DRM SDK API
===========


.. toctree::
:maxdepth: 5

cpp_api
c_api
2 changes: 1 addition & 1 deletion include/accelize/drmc/metering.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ limitations under the License.
extern "C" {
#endif

#include "stdint.h"
#include <stdint.h>

struct MeteringSessionManager_s;

Expand Down
Loading

0 comments on commit cef6dc5

Please sign in to comment.