You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by be...@apache.org on 2015/06/09 10:49:59 UTC
[1/2] mesos git commit: Added mainpage to doxygen documentation.
Repository: mesos
Updated Branches:
refs/heads/master 919d405ac -> 118c9d56b
Added mainpage to doxygen documentation.
Review: https://reviews.apache.org/r/35206
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/ff0d3bae
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/ff0d3bae
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/ff0d3bae
Branch: refs/heads/master
Commit: ff0d3bae84a33f38466d568ed00782272eb5e4d6
Parents: 919d405
Author: Joerg Schad <jo...@mesosphere.io>
Authored: Tue Jun 9 01:40:58 2015 -0700
Committer: Benjamin Hindman <be...@gmail.com>
Committed: Tue Jun 9 01:40:58 2015 -0700
----------------------------------------------------------------------
Doxyfile | 5 +++--
src/main.dox | 12 ++++++++++++
2 files changed, 15 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/ff0d3bae/Doxyfile
----------------------------------------------------------------------
diff --git a/Doxyfile b/Doxyfile
index cdc4c12..1b0a2be 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = mesos
+PROJECT_NAME = "Apache Mesos"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@@ -570,7 +570,8 @@ WARN_LOGFILE =
INPUT = ../include/ ../src/ \
../3rdparty \
- ../docs
+ ../docs \
+ ../src/main.dox
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
http://git-wip-us.apache.org/repos/asf/mesos/blob/ff0d3bae/src/main.dox
----------------------------------------------------------------------
diff --git a/src/main.dox b/src/main.dox
new file mode 100644
index 0000000..d5b29cf
--- /dev/null
+++ b/src/main.dox
@@ -0,0 +1,12 @@
+/**
+ * @mainpage Mesos API Documentation
+ *
+ * The following Apache Mesos API documention is part of the overall [Apache Mesos documenation](http://mesos.apache.org/documentation/latest/).
+ *
+ * @section style-guide Style Guide
+ * * [Style Guide](http://mesos.apache.org/documentation/latest/mesos-c++-style-guide/) for adding and updating doxygen documentation.
+ *
+ * @section user-guide User Guides
+ * * [Libprocess User Guide](http://mesos.apache.org/api/latest/c++/md_3rdparty_libprocess_README.html)
+ * * [Stout User Guide](http://mesos.apache.org/api/latest/c++/md_3rdparty_libprocess_3rdparty_stout_README.html)
+ */
[2/2] mesos git commit: Included doxygen documentation in
docs/home.md.
Posted by be...@apache.org.
Included doxygen documentation in docs/home.md.
Review: https://reviews.apache.org/r/35207
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/118c9d56
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/118c9d56
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/118c9d56
Branch: refs/heads/master
Commit: 118c9d56b534af05d80051991b67e3058f006ccd
Parents: ff0d3ba
Author: Joerg Schad <jo...@mesosphere.io>
Authored: Tue Jun 9 01:49:25 2015 -0700
Committer: Benjamin Hindman <be...@gmail.com>
Committed: Tue Jun 9 01:49:25 2015 -0700
----------------------------------------------------------------------
docs/home.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/118c9d56/docs/home.md
----------------------------------------------------------------------
diff --git a/docs/home.md b/docs/home.md
index ade73d4..ee3d3e9 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -38,7 +38,7 @@ layout: documentation
## Mesos Modules
-* [Mesos Modules](/documentation/latest/modules/) for specifying mesos modules for master, slave and tests.
+* [Mesos Modules](/documentation/latest/modules/) for specifying Mesos modules for master, slave and tests.
## Contributing to Mesos
@@ -48,8 +48,9 @@ layout: documentation
* [Engineering Principles and Practices](/documentation/latest/engineering-principles-and-practices/) to serve as a shared set of project-level values for the community.
* [Committing](/documentation/latest/committing/) guidelines for committing changes.
* [Committers and Maintainers](/documentation/latest/committers/) a listing of project committers and component maintainers; useful when seeking feedback.
-* [C++ Style Guide](/documentation/latest/mesos-c++-style-guide/)
* [Doxygen](/api/latest/c++/) documents the internal Mesos APIs.
+* [C++ Style Guide](/documentation/latest/mesos-c++-style-guide/)
+* [Doxygen Style Guide](/documentation/latest/mesos-doxygen-style-guide/)
* [Development Roadmap](/documentation/latest/mesos-roadmap/)
* [Release Guide](/documentation/latest/release-guide/)