[Mono-list] ECMA compliance
Miguel de Icaza
miguel@ximian.com
22 Nov 2001 09:49:00 -0500
[ Ismael, Juantomas, can you describe the problem with embedding
documentation in the source code for the purpose of translating that
documentation into other languages? ]
> Yeah, this is where I was planning on starting. While identifying possible
> coverage holes will be pretty trivial, I'm open to any suggestions on an
> efficient way to insert the ECMA API docs into existing files.
Copy paste is the best I can think of.
Not only that, but you want to do manual loving to the result, we do not
want the class library to look very ugly.
Now, someone in Spain told me:
`Please do not embed documentation in the source code'
They have been involved in various projects to translate documentation
for various APIs in the past and they have various comments on why it is
a bad idea. I have CCed my friends who can probably articulate this
better than I do.
So something to keep in mind, we might end up with a solution where we
move the documentation to an external file to satisfy those needs.
Miguel.