[DEV] add documentation generation

This commit is contained in:
Edouard DUPIN 2013-12-04 23:44:26 +01:00
parent 4d1a39adcb
commit 5a2362c137
2 changed files with 7 additions and 5 deletions

View File

@ -426,13 +426,14 @@ namespace etk
* @param[in] input The compared Matix. * @param[in] input The compared Matix.
* @return The absolute max value. * @return The absolute max value.
*/ */
T maxDifference(const Matrix<T>& input) T maxDifference(const Matrix<T>& input) {
{
if (m_size != input.m_size) if (m_size != input.m_size)
TK_WARNING("better to do with same size Matrix"); TK_WARNING("better to do with same size Matrix");
} }
T max = 0; T max = 0;
for(int32_t iii=0; iii<m_data.size() && iii<input.m_data.size(); iii++) { for(int32_t iii = 0;
iii < m_data.size() && iii < input.m_data.size();
++iii) {
T diff = m_data[iii] - input.m_data[iii]; T diff = m_data[iii] - input.m_data[iii];
if (diff<0) { if (diff<0) {
diff = -diff; diff = -diff;
@ -446,8 +447,7 @@ namespace etk
/** /**
* @brief Clear all the matrix. * @brief Clear all the matrix.
*/ */
void clear(void) void clear(void) {
{
// copy data for the same size : // copy data for the same size :
for (int32_t iii=0; iii< m_size.x*m_size.y; iii++) { for (int32_t iii=0; iii< m_size.x*m_size.y; iii++) {
m_data[iii] = (T)0; m_data[iii] = (T)0;

View File

@ -5,6 +5,8 @@ import lutinTools
def Create(target): def Create(target):
# module name is 'edn' and type binary. # module name is 'edn' and type binary.
myModule = lutinModule.module(__file__, 'etk', 'LIBRARY') myModule = lutinModule.module(__file__, 'etk', 'LIBRARY')
# enable doculentation :
myModule.doc_enable()
# add extra compilation flags : # add extra compilation flags :
myModule.add_extra_compile_flags() myModule.add_extra_compile_flags()
# add the file to compile: # add the file to compile: