celix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rlenfer...@apache.org
Subject [celix] branch develop updated: Added mainpage to Doxygen output
Date Mon, 23 Sep 2019 17:03:09 GMT
This is an automated email from the ASF dual-hosted git repository.

rlenferink pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/celix.git


The following commit(s) were added to refs/heads/develop by this push:
     new ad1e6c8  Added mainpage to Doxygen output
ad1e6c8 is described below

commit ad1e6c83b48eb5fef2d2d9c3e12fafad7e49ca21
Author: Roy Lenferink <lenferinkroy@gmail.com>
AuthorDate: Mon Sep 23 19:02:44 2019 +0200

    Added mainpage to Doxygen output
---
 Doxyfile  | 7 ++++---
 README.md | 2 +-
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/Doxyfile b/Doxyfile
index eb11ad1..757261a 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -771,7 +771,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = libs/framework/include/celix_api.h libs/framework/include/celix_bundle.h
libs/framework/include/celix_bundle_activator.h libs/framework/include/celix_bundle_context.h
libs/framework/include/celix_framework.h libs/framework/include/celix_dm_component.h libs/framework/include/celix_dm_info.h
libs/framework/include/celix_dm_service_dependency.h
+INPUT                  = README.md libs/framework/include/celix_api.h libs/framework/include/celix_bundle.h
libs/framework/include/celix_bundle_activator.h libs/framework/include/celix_bundle_context.h
libs/framework/include/celix_framework.h libs/framework/include/celix_dm_component.h libs/framework/include/celix_dm_info.h
libs/framework/include/celix_dm_service_dependency.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -800,7 +800,8 @@ FILE_PATTERNS          = *.h \
                          *.hh \
                          *.hxx \
                          *.hpp \
-                         *.h++
+                         *.h++ \
+                         *.md
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -924,7 +925,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = 
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
diff --git a/README.md b/README.md
index 60060fe..a1a9b5e 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ limitations under the License.
 -->
 
 # Apache Celix [![Build Status](https://travis-ci.org/apache/celix.svg?branch=develop)](https://travis-ci.org/apache/celix)
[![Coverage Status](https://coveralls.io/repos/apache/celix/badge.svg?branch=develop&service=github)](https://coveralls.io/github/apache/celix?branch=develop)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/6685/badge.svg)](https://scan.coverity.com/projects/6685)
-Apache Celix is an implementation of the OSGi specification adapted to C and C++ (C++11).
It is a provides a framework to develop (dynamic) modular software applications using component
and/or service-oriented programming.
+Apache Celix is an implementation of the OSGi specification adapted to C and C++ (C++11).
It is a framework to develop (dynamic) modular software applications using component and/or
service-oriented programming.
 
 ## Building
 For information how to build Apache Celix see [Building Apache Celix](documents/building/README.md)


Mime
View raw message