c++ - Doxygen command paragraph (hanging) indentation limitations? -


are there limits how indentation can used on multi-line (paragraph) commands?

consider typical use-case of @details in context of function:

/**  * @brief foo.  * @details lorem ipsum dolor sit amet, mentitum rationibus nec an.  *          usu magna eirmod et, aperiri discere volumus pri ex.  *  *          te pro alii vidit, cu nonumes mediocritatem duo.  *          paulo detracto tincidunt id vim, ad has oblique percipit.  *  * @tparam t argument type.  * @param param1 first parameter.  * @param param2 second parameter.  * @return return value.  */  template< typename t >  inline  t foo( t const& param1, t const& param2 ); 

the long @details paragraphs have wrapped, leads question of there restrictions on indentation?

i know doxygen uses markdown, has specific indentation restrictions / uses, such "4 space indentation" codeblocks. indentation above confuse or conflict in cases wanted insert code?

more generally, there other indentation uses , possible conflicts i'm unaware of?

@thomas-matthews, question technical limitations, not aesthetic style.


Comments

Popular posts from this blog

javascript - how to protect a flash video from refresh? -

android - Associate same looper with different threads -

visual studio 2010 - Connect to informix database windows form application -