Skip to content

Commit

Permalink
* Updated docs/README.txt to reflect how to generate c++ doxygen and …
Browse files Browse the repository at this point in the history
…Java javadocs by hand
  • Loading branch information
jredmondson committed Jun 14, 2018
1 parent 02617a9 commit 671ec89
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions docs/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,20 @@ MADARA HELP DOCUMENTATION INFORMATION

2. GENERATING DEVELOPER DOCUMENTATION

2.1. KaRL
2.1. MADARA C++

The (K)nowledge (a)nd (R)easoning (L)anguage is a module of MADARA that
supports distributed knowledge and reasoning for real-time and
continuous systems. Generating documentation is as easy as typing the
following from the $MADARA_ROOT/docs directory in a terminal
('cmd' in Windows):
The main documentation generation can be done with the following:

perl get_version.pl
doxygen Doxyfile_MADARA

2.2. MADARA Java

The documentation for the Java port can be generated with the following:

doxygen Doxyfile_KaRL
javadoc -version -d java -sourcepath ../port/java/src -subpackages com.madara

2.2. KATS
2.3. KATS

The (K)aRL (A)utomated (T)esting (S)uite is a module of MADARA that
provides a distributed automated testing framework for blackbox or
Expand All @@ -61,7 +64,7 @@ MADARA HELP DOCUMENTATION INFORMATION
$MADARA_ROOT/bin/kats_observer --help
$MADARA_ROOT/bin/kats_sleep --help

2.3. MAML
2.4. MAML

The (M)adara (A)ndroid (M)onkeyrunner (L)ibrary is a Python library for
automating Android smart phone testing. The library provides an
Expand Down

0 comments on commit 671ec89

Please sign in to comment.