Hello,

I am new here and I want to know, how to make a documentation for my libraries. I have always a library published, but I am searching for a way to write the documentation for class and function definition. It might be possible, that this is a common problem for many users, because not every library has a documentation attached. Could any body describe how to start making a documentation with the mbed wiki.

Greetings

Michael (Exkalibur28)

To begin with, the best place to start the documention is in your code. Use doxygen commenting on your classes, functions, data struct and members etc. If you follow the standard doxygen commenting then your project will "self document" itself when published. If you want to know more about doxygen then Google is your friend :)

Ok, thanks.

Then i will try to install the UNIX Sources onto my Mac...

Why? When you publish your program the mbed.org site does it for you. See this as an example

Hello,

thannks for your answer. I have handled the commands by hand and it works: Sensirion

Cool, looks good! Although I don't know what you meant by "handled the commands by hand" though.

Hi Michael,

There is also a brief tutorial on how to write documentation at http://mbed.org/cookbook/Documenting-a-Library

It shows how you can get the site to generate your documentation, and how to embed useful sections in to the wiki. Hope that fills in any remaining details!

Simon

Hi Andy,

my problem was, that I don't know everything about doxygen. I thought, that i need this tool on my PC at home. It was a kind of missunderstanding.

Michael