what are " 2 * \a ", " \a a/\a b ", " \e ref/\e 2n " means? Topic is solved

[Arlenchen]

Hi,

I am reading the xs1.h for the functions.
but some of the description is hard to make sure its meaning.
such like:

void configure_clock_rate(clock clk, unsigned a, unsigned b);
1. rate of (\a a/\a b) MHz ==> is this means (a^2)/(ab) ???
2. (\e ref/\e 2n) MHz or (\e tileclk/\e 2n) MHz ==> (e*ref)/(e^2n) ???

void configure_clock_src_divide(clock clk, void port p, unsigned char d);
1. divided by 2 * \a divide ==> 2* (1/a) ???????


is there any document that teaching how to read the comment in xs1.h?

[henk]

Hi Arienchen - it is doxygen format:

<https://www.stack.nl/~dimitri/doxygen/m ... mands.html>

\a and \e mean italics.
So it is a/b (a divided by b), ref/2n (ref divided by 2n), and divided by 2*divide