====== Renaming library to ndn-cxx ======
Dependent applications should perform the following changes:
* all includes should be changed from <ndn-cpp-dev/...> to <ndn-cxx/...>
* documentation files/comments referring to ndn-cpp-dev should be
updated and refer to ndn-cxx
* if the app uses pkgconfig for dependency detection, 'libndn-cpp-dev'
should be replaced with 'libndn-cxx'. Example for waf users:
conf.check_cfg(package = 'libndn-cxx', args = ['--cflags', '--libs'],
uselib_store = 'NDN_CXX', mandatory = True)
Change-Id: I92d9ec7ff176b9fe8b4352bf04bbb32aa810422d
Refs: #1491
diff --git a/docs/code-style.rst b/docs/code-style.rst
index c6d2c5a..cd21585 100644
--- a/docs/code-style.rst
+++ b/docs/code-style.rst
@@ -1,5 +1,5 @@
-Code style and coding guidelines
-================================
+ndn-cxx Code Style and Coding Guidelines
+========================================
Based on
diff --git a/docs/conf.py b/docs/conf.py
index c8f55dc..60baa9a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -45,7 +45,7 @@
master_doc = 'index'
# General information about the project.
-project = u'C++ library for Named Data Networking'
+project = u'NDN C++ library with eXperimental eXtensions'
copyright = u'2014, Named Data Networking Project'
# The version info for the project you're documenting, acts as replacement for
@@ -53,9 +53,9 @@
# built documents.
#
# The short X.Y version.
-version = '0.4.0'
+version = '0.1.0'
# The full version, including alpha/beta/rc tags.
-release = '0.4.0'
+release = '0.1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -179,7 +179,7 @@
html_file_suffix = ".html"
# Output file base name for HTML help builder.
-htmlhelp_basename = 'ndn-cpp-dev-docs'
+htmlhelp_basename = 'ndn-cxx-docs'
# -- Options for LaTeX output ---------------------------------------------
@@ -199,7 +199,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- ('index', 'ndn-cpp-dev-docs.tex', u'C++ library for Named Data Networking',
+ ('index', 'ndn-cxx-docs.tex', u'NDN C++ library with eXperimental eXtensions',
u'Named Data Networking Project', 'manual'),
]
diff --git a/docs/doxygen.conf b/docs/doxygen.conf
index 325461f..9998dd2 100644
--- a/docs/doxygen.conf
+++ b/docs/doxygen.conf
@@ -32,13 +32,13 @@
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = "C++ library for Named Data Networking"
+PROJECT_NAME = "NDN C++ library with eXperimental eXtensions"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = 0.1.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
diff --git a/docs/index.rst b/docs/index.rst
index 58462f4..1e73bdf 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,5 @@
-C++ library for Named Data Networking
-=====================================
+NDN C++ library with eXperimental eXtensions
+============================================
`API documentation (doxygen) <doxygen/annotated.html>`_