refaaxis.blogg.se - Doxygen param type python

#Doxygen param type python code#

It represents an 'output' of the function in that we expect it to be modified somehow by the function. The function returns nothing, but the value to which variable points is changed, hence we call it an output parameter. It is quite reasonable to have a function which has a return value and also has optional return data, eg: one I'm just writing has the signature: / Determine UTF type of a file. Void modify_value(int val, int *variable) As a simpler answer, out parameters are only for results returned via parameters not the return value. * \param variable Function output is written to this variable. * \param val Value calculations are based off. If you want to prevent a part from doxygen can you define #ifndef DOXYGEN_SHOULD_SKIP_THIS or #ifdef DOXYGEN_SHOULD_USE_THIS on the related code.Out parameters are different from return values. The #ifdef DOXYGEN_SHOULD_USE_THIS on example above can be becomes used if for Doxygen another function is needed to describe.

#Doxygen param type python code#

Note Start all VALUE_TEXT at same character to hold a clean code on *.cpp or *.h files.

/// ~~~~~~~~~~~~~ - Here can you define a code example which must start and end with the definition string, also can you define the code style with e.g.

if you add example add this always before, further must you make two empty lines before to prevent add of them on string before! Every file, function declaration, type definition, typedef, define, macro and global variable declaration shall belong to at least one Doxygen group.

/// - Use this to define a field line, e.g./// TEXT_FIELD - Add a much bigger text there if needed./// ERROR_TYPE ERROR_TEXT - If also exception becomes handled, can you use this for description./// VALUE_TEXT - To add a description of return value.ExhaleNode Parameters name (:class:python:str) The name of the. /// VALUE_NAME VALUE_TEXT - To set output parameter defined by name and add a description. This item is the Doxygen hash value, which is not available until after.There the example also add a small table which is useful to describe values. /// VALUE_NAME VALUE_TEXT - To set input parameter defined by name and add a description. builder, LearnerBuilder which creates this Descriptor./// TEXT_FIELD - Add a bigger text there if needed./// \ingroup - Define the group where the documentation part comes in.SWIGHIDDENVIRTUAL bool setCoordinateResolution(long res, int ¬hingExample) / win = xbmcgui.Window(xbmcgui.getCurrentWindowId())

/ ReferenceError If control is already used in another window / TypeError If supplied argument is not of List type, or a / nothingExample Example here, if on value pointer data becomes / Nothing only added as example here :) / to scale control positions and width/heights to whatever resolution An example doxygencommands entry: doxygencommands: COMMANDNAME: type: TYPE inline: INLINE pair: PAIRCMDNAME translatable: CMDTRANSLATABLE parameters: - name: PARAMNAME length: LENGTH required: REQUIRED translatable: PARAMTRANSLATABLE. / That the coordinates of all controls are defined in. You can customize the behavior of the filter by editing existing entries or adding new ones. For functions one can use the param command to document the parameters and then. Here an example on add-on about function coding style: #ifdef DOXYGEN_SHOULD_USE_THIS For Python, VHDL, Fortran, and Tcl code there are different commenting. Start doxygen documentation for add-ons always with /// and on Kodi itself with /*!, this makes it more easy to see for which place the documentation is.