On 12/04/2019 16:36, Clemens Feige wrote:
> [email protected] wrote on 12.04.2019 at 14:25:
>>
>> I have documentation like
>>
>>
>> /// Calculates cost of rectangle with size @p sx x @p sy meters, using
>> given @p price and adding discount if @p prio is below 10.
>>
>> float rect_cost(float sx, float sy, float price, int prio)
>>
>>
>> the problem is that it is not comfortable to human-read nor to write,
>> instead I was looking for something in terms of:
>>
>> /// Calculates cost of rectangle with size $sx x $sy meters, using given
>> $price and adding discount if $prio is below 10.
>>
>> Does such a thing exist, for parameters?
>>
>> If not, could it please be added?
>>
>>
>> Btw: for more general solution it seems that simply defining ALIAS on
>> character, not on @something would work, something like:
>>
>> CHAR_ALIASES="$=\p "
>>
>> would do the trick here and as well allow user to define other custom
>> special rules, from the set of characters that are not used and not
>> reserved.
>>
>> If characters are unicode it could have some interesting future use too.
>>
>
> What is wrong with the ALIASES config option?
>
> http://www.doxygen.nl/manual/config.html#cfg_aliases
>
> This tag can be used to specify a number of aliases that act as
> commands in the documentation. An alias has the form: name=value
>
I want to get to short syntax like "Adds $x and $radius" instead of
"Adds \p x and \p radius". With aliases it would be still the "\A x"
format instead of "$x" right? (where A is defined by me string of at
least 1 characters)
___
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
