c - Doxygen document possible parameter values -


currently c-code function declaration documented follows

/** fubar function  *@param[in]    val1    first input variable  *@param[in]    val2    second input variable  */ void foo (int val1, int val2);

but parameters can except numbers within range, e.g., 0-500

is possible document other part of parameter description? maybe shows separately in produced documentation?

e.g. in latex-produced pdf table produced cell parameter type (int) direction (in) , name (var1/var2). there way of having table cell 0-500?

your best bet may table in detail section. doxygen supports html commands inside documentation, , table generated in pdf looks decent.

/**  * @brief fubar function  * @param[in]    val1    first input variable  * @param[in]    val2    second input variable  *  * <table>  * <tr><td>type</td><td>direction</td><td>name</td><td>value range</td></tr>  * <tr><td>int</td><td>in</td><td>val1</td><td>0-500</td></tr>  * <tr><td>int</td><td>in</td><td>val2</td><td>1-1000</td></tr>  * </table>  */  void foo(int val1, int val2) {}

the issue looks redundant me. perhaps limiting table parameter name , expected value better.

see doxygen manual: html commands set of html supported doxygen.


Comments

Post a Comment

Popular posts from this blog

linux - Does gcc have any options to add version info in ELF binary file? -

i mean whether gcc can insert source code version infor elf binary section or similar. not want change source file, add info gcc option in makefile. you can emit version info text file, turn text file object file statically link executable. the first step simple have write code: script or write version info in format plain text file. write makefile rule produce version.o version.txt, using objcopy . you'll have object file 2 useful symbols defined in it: beginning , end of textual version info. add generated object executable, , you'll able access version 2 ways: running strings on binary, or writing code in application print version string (you'll need declare start , end symbols variables in header file).
Read more

android - send complex objects as post php java -

is possible send contact numbers via post php class inside eclipse ? or post limited primitive types , have find work arounds send them string ? i propose: send them json in post request, befor start, have @ gson project , keep in mind set content application -> json. luck
Read more

charts - What graph/dashboard product is facebook using in Dashboard: PUE & WUE -

i love facebook dashboard: pue & wue. beautifull can point out if there open source or commercial product offer similar style? here link https://www.facebook.com/forestcitydatacenter?sk=app_288655784601722&app_data so read through 29,888 lines of javascript ya.. biggest js file i've ever seen. looks make graph using variety of tools, including tween.js . it'd fascinating chat whoever made it. code wheel graph object starts @ line 27,266 text var graphcomponent = class.extend({ . can find source @ https://www.fbpuewue.com/assets/application-3a3af20f7fa3591229c79442ae3d1c26.js . sorry if dissapoints it's not awesome plugin can use :/ share pain. let me know if have questions :)
Read more