Poor Documentation

[fas]

The documentation is poor. I'm trying to understand how the I2C driver works and there's this line in the source code:
gt when timerafter(time) :> int _;

What does this mean? This particular syntax is not described anywhere.

Then there's this gem from the xTime Composer User's Guide for the description of configure_clock_rate:
"The hardware supports rates of MHz and rates of the form ( MHz or ( MHz
where is the reference clock frequency, is the xCORE tile frequency and is a
number in the range 1 to 255 inclusive."

[Bianco]

https://www.xmos.com/published/how-peri ... sing-timer

In this case int _ has the same effect as using void

[fas]

https://www.xmos.com/published/how-peri ... sing-timer

In this case int _ has the same effect as using void

Thanks but how is one supposed to find these things? That page isn't referenced anywhere under support and entering "timer" in the search of Knowledgebase Q&A doesn't find it.

And how about someone fixing all the typos in the manuals? I have no idea how to use configure_clk_rate because the description is gibberish.

[peter]

Hi fas,

Thanks for pointing out the issue in the xTIMEcomposer User Guide. Looks like there is a bug in our tool that creates user documentation from source code. I will file a bug internally and see what it will take to get that fixed.

Regards,

Peter