Appledoc examples

[emilio fernandez]

Hi, is there any place where I can find examples of Appledoc usages? I would like to see how Appledoc is used to generate the documentation of some libraries like AFNetworking, RESTKit, etc.

Thank you in advance.

[Tom @ Gentle Bytes]

The best way would be to actually check source code of mentioned libraries - usually header files.

--

Sent from my iPhone

On 30. okt. 2013, at 16:46, emilio fernandez via appledoc <appledoc+noreply-APn2wQforl1gBOZ...@googlegroups.com> wrote:

Hi, is there any place where I can find examples of Appledoc usages? I would like to see how Appledoc is used to generate the documentation of some libraries like AFNetworking, RESTKit, etc.

Thank you in advance.

--
You received this message because you are subscribed to the Google Groups "appledoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email to appledoc+u...@googlegroups.com.
To post to this group, send email to appl...@googlegroups.com.
Visit this group at http://groups.google.com/group/appledoc.
For more options, visit https://groups.google.com/groups/opt_out.

[emilio fernandez]

I have checked out the source code and generate the documentation with Appledoc, but you only get the documentation that is in the comments.

Taken as an example the docs from AFNetworking, I would like to have an example of how to create a similar introduction page, with code snippets, etc. 

Is there any place where I can find such kind of examples?

El miércoles, 30 de octubre de 2013 21:16:48 UTC+1, Tom escribió:

The best way would be to actually check source code of mentioned libraries - usually header files.

--

Sent from my iPhone

[Tom @ Gentle Bytes]

It uses the same markdown syntax as code comments. You can simply create a .markdown file with contents and include it with cmd line switch. Currently I don't have example of this on my website (work in progress), but you can get it via web archive (http://web.archive.org/web/20120615004324/http://gentlebytes.com/appledoc-docs-examples-documents/). You can additionally consult AFNetworking example where you can see both - compiled docs and sources.

Tom

--

Sent from my iPhone

[emilio fernandez]

Thanks a lot for that article - it's exactly what I was looking for.

Emilio

El jueves, 31 de octubre de 2013 14:41:51 UTC+1, Tom escribió:

It uses the same markdown syntax as code comments. You can simply create a .markdown file with contents and include it with cmd line switch. Currently I don't have example of this on my website (work in progress), but you can get it via web archive (http://web.archive.org/web/20120615004324/http://gentlebytes.com/appledoc-docs-examples-documents/). You can additionally consult AFNetworking example where you can see both - compiled docs and sources.

Tom

--

Sent from my iPhone