You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ka...@apache.org on 2016/02/20 17:47:51 UTC
[2/4] mesos git commit: Remove markdown files from doxygen.
Remove markdown files from doxygen.
* The doxygen html pages corresponding to doc/* markdown files are
redundant and have broken links. As such, they don't serve any
reasonable purpose in doxygen site.
* Also updated the main page to include direct links to libprocess/stout
developer guides.
* Updated site/README.md to include instructions for updating doxygen
and javadocs pages.
Review: https://reviews.apache.org/r/43319
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/52857aca
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/52857aca
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/52857aca
Branch: refs/heads/master
Commit: 52857acac781b84b003a6f1fdc69cb640bd361da
Parents: af14c38
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Tue Feb 2 18:59:18 2016 -0500
Committer: Kapil Arya <ka...@mesosphere.io>
Committed: Sat Feb 20 11:46:55 2016 -0500
----------------------------------------------------------------------
Doxyfile | 3 +--
site/README.md | 11 +++++++++++
src/main.dox | 9 +++------
3 files changed, 15 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/52857aca/Doxyfile
----------------------------------------------------------------------
diff --git a/Doxyfile b/Doxyfile
index d6dcb6b..779a8ea 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -576,7 +576,6 @@ WARN_LOGFILE =
INPUT = ../include/ ../src/ \
../3rdparty \
- ../docs \
../src/main.dox
# This tag can be used to specify the character encoding of the source files
@@ -594,7 +593,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
-FILE_PATTERNS = *.h *.hpp *.md
+FILE_PATTERNS = *.h *.hpp
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
http://git-wip-us.apache.org/repos/asf/mesos/blob/52857aca/site/README.md
----------------------------------------------------------------------
diff --git a/site/README.md b/site/README.md
index 78609fb..eb90a86 100644
--- a/site/README.md
+++ b/site/README.md
@@ -21,6 +21,17 @@ files within the source folder.
../support/generate-help-site.py
rake
+The doxygen and javadoc pages must be generated _after_ running `rake`.
+
+### Generating doxygen pages
+Doxygen pages can be generated using:
+
+ rake doxygen
+
+### Generating javadoc pages
+Javadoc pages can be generated using:
+
+ rake javadoc
## Development
To live edit the site run `rake dev` and then open a browser window to
http://git-wip-us.apache.org/repos/asf/mesos/blob/52857aca/src/main.dox
----------------------------------------------------------------------
diff --git a/src/main.dox b/src/main.dox
index d5b29cf..a6765f6 100644
--- a/src/main.dox
+++ b/src/main.dox
@@ -3,10 +3,7 @@
*
* 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)
+ * @section developer-guide Developer Guides
+ * * [Libprocess developer guide](https://github.com/apache/mesos/blob/master/3rdparty/libprocess/README.md/)
+ * * [Stout developer guide](https://github.com/apache/mesos/blob/master/3rdparty/libprocess/3rdparty/stout/README.md/)
*/