From 33d985fcac8ba5342b7b5b86c995066150eb564d Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Fri, 8 Apr 2016 22:14:28 +0200 Subject: [PATCH] [DOC] better doc --- doc/build.md | 69 +++++++++++++++++++++++++++++++++++++++++++++ doc/mainpage.md | 27 ++++++++++++------ doxy_etk.py | 34 ++++++++++++++++++---- etk/Color.h | 6 +++- etk/Hash.h | 6 +++- etk/math/Vector4D.h | 1 + etk/types.h | 2 +- 7 files changed, 128 insertions(+), 17 deletions(-) create mode 100644 doc/build.md diff --git a/doc/build.md b/doc/build.md new file mode 100644 index 0000000..5419a6b --- /dev/null +++ b/doc/build.md @@ -0,0 +1,69 @@ +Build lib & build sample {#etk_build} +======================== + +@tableofcontents + +Download: {#etk_build_download} +========= + +etk use some tools to manage source and build it: + +lutin (build-system): {#etk_build_download_lutin} +--------------------- + +```{.sh} + pip install lutin --user + # optionnal dependency of lutin (manage image changing size for application release + pip install pillow --user +``` + + +dependency: {#etk_build_download_dependency} +----------- + +```{.sh} + mkdir framework + cd framework + git clone https://github.com/atria-soft/elog.git + cd .. +``` + +sources: {#etk_build_download_sources} +-------- + +```{.sh} + cd framework + git clone https://github.com/atria-soft/etk.git + cd .. +``` + +Build: {#etk_build_build} +====== + + +library: {#etk_build_build_library} +-------- + +```{.sh} + lutin -mdebug etk +``` + +test: {#etk_build_build_sample} +----- + +```{.sh} + lutin -mdebug etk-test +``` + +Or simple: + +```{.sh} + lutin -mdebug etk-* +``` + +Run sample: {#etk_build_run_sample} +=========== + +```{.sh} + lutin -mdebug etk-test?run +``` diff --git a/doc/mainpage.md b/doc/mainpage.md index dedd4b4..28c88a7 100644 --- a/doc/mainpage.md +++ b/doc/mainpage.md @@ -1,8 +1,8 @@ -ETK library {#mainpage} +ETK library {#mainpage} =========== -What is ETK, and how can I use it? ----------------------------------- +What is ETK, and how can I use it? {#etk_mainpage_what} +================================== ETK, or Ewol Tool kit is a simple abstraction layer for some elements like mutex, std missing element(in android or MacOS) and ... @@ -19,20 +19,20 @@ ETK is composed of some part: -What languages are supported? ------------------------------ +What languages are supported? {#etk_mainpage_langue} +============================= ETK is written in C++. -Are there any licensing restrictions? -------------------------------------- +Are there any licensing restrictions? {#etk_mainpage_dependency} +===================================== ETK is **FREE software** and _all sub-library are FREE and staticly linkable !!!_ -License (APACHE-2.0) --------------------- +License (APACHE-2.0) {#etk_mainpage_licence} +==================== Copyright etk Edouard DUPIN @@ -48,3 +48,12 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +Other pages {#etk_mainpage_sub_page} +=========== + + - @ref etk_build + - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html) + + + diff --git a/doxy_etk.py b/doxy_etk.py index 10a3181..9540824 100644 --- a/doxy_etk.py +++ b/doxy_etk.py @@ -12,15 +12,39 @@ def create(target, module_name): my_module.set_website_sources("http://github.com/atria-soft/" + module_name) my_module.add_path([ module_name, - "doc" + "doc", + ]) + my_module.add_data_path([ + "data/dox", ]) - my_module.add_data_path("data/dox") my_module.add_module_depend([ - 'elog' + 'elog', ]) my_module.add_module_define([ - "ETK_BUILD_MINIZIP" - ]) + "ETK_BUILD_MINIZIP", + ]) + my_module.add_exclude_symbols([ + '*operator<<*', + '*string_to_*', + '*compare_no_case*', + '*end_with*', + '*extract_line*', + '*isIn*', + '*matRotate2*', + '*replace*', + '*sort*', + '*split*', + '*start_with*', + 'tolower', + 'toupper', + ]) + my_module.add_exclude_file([ + 'debug.h', + ]) + my_module.add_file_patterns([ + '*.h', + '*.md', + ]) return my_module diff --git a/etk/Color.h b/etk/Color.h index 9fad0bb..5df3b5e 100644 --- a/etk/Color.h +++ b/etk/Color.h @@ -442,7 +442,11 @@ namespace etk { */ etk::Color parseStringColorNamed(const std::string& _input); - //! @not_in_doc + /** + * @brief Specify that the Get intance is specialized for uint8_t/4 template + * @return unsignad iterger containing the color value in RGBA + * @internal + */ template<> uint32_t Color::get() const; template uint32_t Color::get() const { diff --git a/etk/Hash.h b/etk/Hash.h index c662f82..ce4b621 100644 --- a/etk/Hash.h +++ b/etk/Hash.h @@ -146,7 +146,11 @@ namespace etk { MY_TYPE& operator[] (const std::string& _key) { return get(_key); } - //! @previous + /** + * @brief Get an copy Element an a special position + * @param[in] _key Name of the hash requested + * @return An reference on the copy of selected element + */ const MY_TYPE& operator[] (const std::string& _key) const { return get(_key); } diff --git a/etk/math/Vector4D.h b/etk/math/Vector4D.h index d3ddd7b..56bb44c 100644 --- a/etk/math/Vector4D.h +++ b/etk/math/Vector4D.h @@ -218,6 +218,7 @@ namespace etk { } /** * @brief Return a vector will the absolute values of each element + * @return New vector with the absolute value */ Vector4D absolute() const { return Vector4D( abs(m_floats[0]), diff --git a/etk/types.h b/etk/types.h index 16b3a6a..1357184 100644 --- a/etk/types.h +++ b/etk/types.h @@ -51,7 +51,7 @@ #ifndef _WIN32 #include #ifndef _MATH_H_MATHDEF - //! @not_in_doc + //! @brief Generate a basic type for floating point unit selection (not finished) using float_t = float; #endif #endif