On 21/06/2014 05:35, Trevor Linton wrote:
> I'm not sure, it's unfortunately one of those problems i'm unsure if
> there's a complete solution to. The documentation is very complete in
> emscripten.h, i'm generally a fan of looking at things from users
> perspectives. Most who are looking at documentation or have questions
> would first go to the documentation (at least that's my experience),
> generally someone pokes around at a header file as a last resort (at
> least thats just me). In addition, jekyll and wiki's have the luxury
> of layout which allows you to add images, diagrams, links to other
> sources. So, i'd say simple notes in the header that refer to the URL
> for the documentation and keep all the documentation in one place.
>
The solution to this problem is tools like Doxygen. Such tools allow you
to write the documentation in the .h file in a way from which the tool
can generate more user friendly documentation. I think it is a good idea
to have the full documentation with the code because it is more likely
to get updated when the code is updated. Tools like Doxygen enable this.
Regards
-Mark
--
注意：この電子メールには、株式会社エイチアイの機密情報が含まれている場合
が有ります。正式なメール受信者では無い場合はメール複製、 再配信または情
報の使用を固く禁じております。エラー、手違いでこのメールを受け取られまし
たら削除を行い配信者にご連絡をお願いいたし ます.
NOTE: This electronic mail message may contain confidential and
privileged information from HI Corporation. If you are not the intended
recipient, any disclosure, photocopying, distribution or use of the
contents of the received information is prohibited. If you have received
this e-mail in error, please notify the sender immediately and
permanently delete this message and all related copies.
--
You received this message because you are subscribed to the Google Groups
"emscripten-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
