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.
But that's just me. Let me know how you'd like help! On Friday, June 20, 2014 12:52:08 PM UTC-6, Alon Zakai wrote: > > Thanks, help is always welcome. > > I guess the first question here is where to put the docs - we have > emscripten.h docs inline, and I'm worried about copying it to another place > without removing the original, to avoid duplication and one being out of > date etc. So the question is, is comments in the source better than a > separate doc? Comes down to what people prefer I guess. Thoughts? > > - Alon > > > > On Fri, Jun 20, 2014 at 10:02 AM, Trevor Linton <[email protected] > <javascript:>> wrote: > >> I'd be happy to help. One aspect I think could use a very thorough once >> over is the emscripten.h C documentation, shouldn't be difficult bringing >> it to a wiki or jekyll. Also, the emcc/em++ command line options, there >> are some options aren't documented (other than the paragraph found in the >> help). >> >> If there's anything you'd like me to take a pass at, let me know. >> >> >> On Wednesday, June 18, 2014 12:17:00 PM UTC-6, Alon Zakai wrote: >>> >>> Hi everyone, >>> >>> We are planning to start an overhaul of the emscripten documentation >>> soon, that is, of the contents of the wiki on github. One option might be >>> to move to Jekyll, which is convenient as it has good github integration. >>> >>> If you have any thoughts on the current docs and how they can be >>> improved, let's discuss here. >>> >>> - Alon >>> >>> -- >> 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] <javascript:>. >> For more options, visit https://groups.google.com/d/optout. >> > > -- 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.
