topic Re: SDK documentation in MCUXpresso SDK

SDK documentation

superaga — Tue, 16 Feb 2021 05:43:58 GMT

Hi experts,

I already post over a reply on this topic at this link, but probably went lost inside the old answers, so I rewrite it here.

I'm using the latest MCUXpresso 11.3.0.

I installed the SDK_2.9.0_FRDM-K64F for which I'd like to access to the API documentation.

I can open the SDK Getting started or the Release notes from:

within the MCUXpresso IDE or
from the docs folder inside the SDK or
from the SDK web page

Unfortunately none of the 3 above point me to the SDK documentation. I found "something" just using Google a this address but of course I think there is a better way to access to the official documentation. What is it?

One more, I think that would be very appreciated been able to open the SDK html (exist?!?) from within the MCUXpresso IDE.

Would be also very useful use the context menu over a function to open directly the function doc (I suppose the SDK is done with the Doxygen).

Any help would be very appreciated! Many thanks!

Kind regards,

AGA

Re: SDK documentation

danielchen — Wed, 17 Feb 2021 05:25:49 GMT

Hi @superaga ;

Please download the SDK documentation from

https://mcuxpresso.nxp.com/en/welcome

when you download the SDK.

Regards

Daniel

Re: SDK documentation

superaga — Wed, 17 Feb 2021 08:00:27 GMT

Hi @danielchen,

many thanks for your answer.

I didn't have the documentation since I installed the SDK from within MCUXpresso IDE (as in this guide).

Is there a way to download it from the IDE?

One suggestion: would be very useful to access the API documentation from the IDE itself, "like the tooltips when hovering the mouse on code".

Best regards,

AGA

Re: SDK documentation

danielchen — Wed, 17 Feb 2021 10:02:36 GMT

Hi @superaga

Thank you for your good suggestions.

Currently SDK documents are downloaded from mcuxpresso.com . I also attached API doc here.

I will report your suggestion to the SDK team.

Regards

Daniel

Re: SDK documentation

danielholala — Thu, 18 Feb 2021 10:37:49 GMT

Hi AGA,

the link you posted points to a "API Reference Manual" in PDF format.

I think that this PDF document contains information very similar to what is provided on https://mcuxpresso.nxp.com/en/apidoc/ (created from doxygen comments, or so it seems).

Just checked for "MK64FN1M0xxx12" (this might not be exactly your processor) that is to be found here:

https://mcuxpresso.nxp.com/api_doc/dev/2117/

What do you think?

Re: SDK documentation

superaga — Thu, 18 Feb 2021 11:49:17 GMT

Hi @danielholala,

this is exactly what I was looking for!

In fact this, respect the one that I found (PDF), has more details (since it is generated by the function itself) and also more navigable (because the hyperlinks).

It is a shame that this page (the main or the related to the processor) is not directly accessible from the MCUXpresso IDE, that would be super useful.

I think also that NXP should easily provide this link from the main SDK page. May be it's my mistake, but I couldn't find it...

Many thanks to all!

Regards,

AGA