Merge pull request #140 from DICL/add-doxygen-content

Add doxygen content

.travis.yml

@@ -54,10 +54,13 @@ after_success: |
         cd ..
         git config --global user.email "Travis"
         git config --global user.name  "Travis"
+        git submodule init
+        git submodule update
         git submodule add -b gh-pages -f git@github.com:DICL/VeloxDFS ./doc/html
         git submodule update --init -- ./doc/html
         cd doc/html
         git checkout gh-pages
+        rm -rf *
         cd ../
         doxygen
         cd html

Makefile.am

@@ -95,7 +95,6 @@ sysconf_DATA        = doc/eclipse.json
 endif
 
 dist_doc_DATA       = README.md LICENSE doc/eclipse.json
-man1_MANS           = doc/eclipsefs.1
 
 EXTRA_DIST          = doc .autotools_aux $(shell find @srcdir@/src -name "*.hh" -o -name "*.in") \
                       $(sh_scripts) doc/eclipse.json

README.md

@@ -1,11 +1,11 @@
-VeloxDFS  {#mainpage}
-========
----
+VeloxDFS {#mainpage}
+======== 
+<!-- @cond Remove those links for Doxygen-->
+--- 
 [![Build Status](https://travis-ci.org/DICL/VeloxDFS.svg?branch=master)](https://travis-ci.org/DICL/VeloxDFS)
 [![Slack room](https://img.shields.io/badge/slack-join-pink.svg)](https://dicl.slack.com/messages/general/)
-[![ZenHub](https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)](https://zenhub.com)
-[![Analytics](https://ga-beacon.appspot.com/UA-87474237-1/veloxdfs)](https://github.com/DICL/VeloxDFS)
 ---
+<!-- @endcond -->
 
 _VeloxDFS_ is a decentralized distributed file system based on _ChordDHT_ and _HDFS_.
 
@@ -18,25 +18,23 @@ Key features of current VeloxDFS implementation includes:
  - Instead for each file there is a file leader node which holds its metadata.
  - Highly secure and stable, total replication of the system's state.
 
----
-
 USAGE
 =====
-VeloxDFS default launcher is not included in this repository, if you want to use it you can find it [here](https://github.com/DICL/eclipsed).
-
-The reason not to include the launcher inside the package is to let the user to choose any launcher or service managers such as:
+VeloxDFS default [launcher] [eclipsed] is not included in this repository since its a temporary hack and 
+we want to let the user to choose any launcher or service managers such as:
  - systemd/init.d
  - puppet/chef/salt
 
 Once the system is up and running, you can interact with VeloxDFS with the following commands:
-```
- $ dfs put|get|cat|ls|rm|format|pget|update|append
-```
+
+    $ dfs put|get|cat|ls|rm|format|show
+
 
 COMPILING & INSTALLING
 ======================
-
-_Detailed information can be found in the wiki of this repository_
+<!-- @cond Remove those links for Doxygen-->
+Further information can be found it in: [Installation](https://github.com/DICL/VeloxDFS/wiki/Installation)
+<!-- @endcond -->
 
 Compiling requirements
 ----------------------
@@ -62,13 +60,12 @@ For single user installation for developers
     ### This last command will be needed whenever you want to recompile the source
     $ make [-j#] install                                   # Compile & install add -j flag to speed up
 
-Now edit in your **~/.bashrc** or **~/.profile**:
+Now edit in your `~/.bashrc` or `~/.profile`:
 
     export PATH="/home/*..PATH/To/eclipse/..*/sandbox/bin":$PATH
     export LIBRARY_PATH="/home/*..PATH/To/eclipse/..*/sandbox/lib"
     export C_INCLUDE_PATH="/home/*..PATH/To/eclipse/..*/sandbox/include"
 
-
 Default settings for VELOXDFS 
 -----------------------------
 
@@ -90,25 +87,32 @@ Default settings for VELOXDFS
       "replica"  : 1
     }
 
+<!-- @cond Remove those links for Doxygen-->
+Further information can be found it in: [Conf reference](https://github.com/DICL/VeloxDFS/wiki/Configuration-file-reference)
+<!-- @endcond -->
+
 FAQ
 ---
 
 - _Question_ : `configure` stops with errors related to boost library.
 - _Answer_ : It probably means that you do not have boost library installed in
   the default location, in such case you should specify the boost library location.
-  ```
-  sh ../VeloxDFS/configure --prefix ~/sandbox --with-boost=/usr/local --with-boost-libdir=/usr/local/lib
-  ```
+
+        sh ../VeloxDFS/configure --prefix ~/sandbox --with-boost=/usr/local --with-boost-libdir=/usr/local/lib
+
   In this example we assume that the boost headers are in `/usr/local/include` while the library files
   are inside `/usr/local/lib`.
 
 AUTHORS
 =======
 
- - __AUTHOR:__ [Vicente Adolfo Bolea Sanchez](http://vicentebolea.me)
- - __AUTHOR:__ [MooHyeon Nam](https://github.com/nammh)
- - __AUTHOR:__ [WonBae Kim](https://github.com/zwigul)
- - __AUTHOR:__ [KiBeom Jin](https://github.com/kbjin)
- - __AUTHOR:__ [Deukyeon Hwang](https://github.com/deukyeon)
- - __AUTHOR:__ [Prof. Nam Beomseok](http://dicl.unist.ac.kr)
+ - [Vicente Adolfo Bolea Sanchez](http://vicentebolea.me)
+ - [MooHyeon Nam](https://github.com/nammh)
+ - [WonBae Kim](https://github.com/zwigul)
+ - [KiBeom Jin](https://github.com/kbjin)
+ - [Deukyeon Hwang](https://github.com/deukyeon)
+ - [Prof. Nam Beomseok](http://dicl.unist.ac.kr)
  - __INSTITUTION:__ [DICL laboratory](http://dicl.unist.ac.kr) at _UNIST_ 
+
+<!--links-->
+[eclipsed]: https://github.com/DICL/eclipsed

doc/Doxyfile

@@ -52,7 +52,7 @@ PROJECT_BRIEF          = "Distributed file system for Big Data processing"
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = velox_logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -410,7 +410,7 @@ LOOKUP_CACHE_SIZE      = 0
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
 # be included in the documentation.
@@ -754,7 +754,8 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../src
+INPUT                  = ../src 
+INPUT                  += manual/
 INPUT                  += ../README.md
 USE_MDFILE_AS_MAINPAGE = ../README.md
 
@@ -791,7 +792,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = ../doc ../tests
+EXCLUDE                = ../tests manual/Home.md
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1067,7 +1068,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            =
+HTML_HEADER            = ./header.html
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1123,15 +1124,15 @@ HTML_EXTRA_FILES       =
 # Minimum value: 0, maximum value: 359, default value: 220.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_HUE    = 198
 
 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
 # in the HTML output. For a value of 0 the output will use grayscales only. A
 # value of 255 will produce the most vivid colors.
 # Minimum value: 0, maximum value: 255, default value: 100.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_SAT    = 79
 
 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
 # luminance component of the colors in the HTML output. Values below 100
@@ -1142,7 +1143,7 @@ HTML_COLORSTYLE_SAT    = 100
 # Minimum value: 40, maximum value: 240, default value: 80.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE_GAMMA  = 80
+HTML_COLORSTYLE_GAMMA  = 105 
 
 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
 # page will contain the date and time when the page was generated. Setting this
@@ -2156,7 +2157,7 @@ GROUP_GRAPHS           = YES
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-UML_LOOK               = NO
+UML_LOOK               = YES
 
 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
 # class node. If there are many fields or methods and many nodes the graph may

doc/header.html

@@ -0,0 +1,35 @@
+<!-- HTML header for doxygen 1.8.5-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen $doxygenversion"/>
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+$treeview
+$search
+$mathjax
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<div id="titlearea" style="text-align:center">
+  <!--BEGIN PROJECT_LOGO-->
+  <img alt="Logo" style="text-align:center" src="$relpath^$projectlogo"/>
+  <!--END PROJECT_LOGO-->
+
+  <!--BEGIN DISABLE_INDEX-->
+   <!--BEGIN SEARCHENGINE-->
+   <td>$searchbox</td>
+   <!--END SEARCHENGINE-->
+  <!--END DISABLE_INDEX-->
+</div>
+<!--END TITLEAREA-->
+<!-- end header part -->