From c04d53d32513a48187aa51efc9e99e9a140a2689 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sun, 27 Nov 2011 20:27:35 -0500 Subject: docs: added doxygen and swig docs building tools into howto (cmake version only). --- .../doxygen/doxyxml/example/xml/aadvark_8cc.xml | 88 +++ .../doxygen/doxyxml/example/xml/aadvark_8h.xml | 72 ++ .../doxygen/doxyxml/example/xml/classAadvark.xml | 86 +++ .../docs/doxygen/doxyxml/example/xml/combine.xslt | 15 + .../docs/doxygen/doxyxml/example/xml/compound.xsd | 814 +++++++++++++++++++++ .../docs/doxygen/doxyxml/example/xml/index.xml | 17 + .../docs/doxygen/doxyxml/example/xml/index.xsd | 66 ++ 7 files changed, 1158 insertions(+) create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8cc.xml create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8h.xml create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/classAadvark.xml create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/combine.xslt create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/compound.xsd create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xml create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xsd (limited to 'gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml') diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8cc.xml b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8cc.xml new file mode 100644 index 000000000..f031e01ac --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8cc.xml @@ -0,0 +1,88 @@ + + + + aadvark.cc + iostream + aadvark.h + aadvark.cc + + + + + + + + + + + + + + bool + bool aadvarky_enough + (Aadvark aad) + aadvarky_enough + + Aadvark + aad + + + + + + + + + + + int + int main + () + main + + + + + + + + + + + + + + +#include<iostream> +#include"aadvark.h" + +voidAadvark::print(){ +std::cout<<"aadvarkis"<<aadvarkness<<"/10aadvarky"<<std::endl; +} + +Aadvark::Aadvark(intaaness):aadvarkness(aaness){} + +boolaadvarky_enough(Aadvarkaad){ +if(aad.get_aadvarkness()>6) +returntrue; +else +returnfalse; +} + +intAadvark::get_aadvarkness(){ +returnaadvarkness; +} + +intmain(){ +Aadvarkarold=Aadvark(6); +arold.print(); +if(aadvarky_enough(arold)) +std::cout<<"Heisaadvarkyenough"<<std::endl; +else +std::cout<<"Heisnotaadvarkyenough"<<std::endl; +} + + + + + diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8h.xml b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8h.xml new file mode 100644 index 000000000..a1854b685 --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/aadvark_8h.xml @@ -0,0 +1,72 @@ + + + + aadvark.h + iostream + + + + + + + + + + + + Aadvark + + + bool + bool aadvarky_enough + (Aadvark aad) + aadvarky_enough + + Aadvark + aad + + + + + + + + + + + int + int main + () + main + + + + + + + + + + + + + + +#include<iostream> + +classAadvark{ +public: +voidprint(); +Aadvark(intaaness); +intget_aadvarkness(); +private: +intaadvarkness; +}; + +boolaadvarky_enough(Aadvarkaad); + +intmain(); + + + + diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/classAadvark.xml b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/classAadvark.xml new file mode 100644 index 000000000..54fe8b32c --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/classAadvark.xml @@ -0,0 +1,86 @@ + + + + Aadvark + aadvark.h + + + int + int Aadvark::aadvarkness + + aadvarkness + + + + + + + + + + + + void + void Aadvark::print + () + print + +Outputs the vital aadvark statistics. + + + + + + + + + Aadvark::Aadvark + (int aaness) + Aadvark + + int + aaness + + + + + + +aaness + + +The aadvarkness of an aadvark is a measure of how aadvarky it is. + + + + + + + + + int + int Aadvark::get_aadvarkness + () + get_aadvarkness + + + + + + + + + + +Models the mammal Aadvark. + +Sadly the model is incomplete and cannot capture all aspects of an aadvark yet.This line is uninformative and is only to test line breaks in the comments. + + + AadvarkAadvark + Aadvarkaadvarkness + Aadvarkget_aadvarkness + Aadvarkprint + + + diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/combine.xslt b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/combine.xslt new file mode 100644 index 000000000..abdd9ac75 --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/combine.xslt @@ -0,0 +1,15 @@ + + + + + + + + + + + + diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/compound.xsd b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/compound.xsd new file mode 100644 index 000000000..369e2300f --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/compound.xsd @@ -0,0 +1,814 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xml b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xml new file mode 100644 index 000000000..13fd53f90 --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xml @@ -0,0 +1,17 @@ + + + Aadvark + aadvarkness + print + Aadvark + get_aadvarkness + + aadvark.cc + aadvarky_enough + main + + aadvark.h + aadvarky_enough + main + + diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xsd b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xsd new file mode 100644 index 000000000..d7ab2a906 --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/xml/index.xsd @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit