Hi Ian, > looks like the xmldoc attribute you mention in a later email > is the way > to get around this. We would invoke ndoc once for each > translated language.
Exactly...
> although we should be able to knock up a script to generate
> stubs based
> on the original english doc.
>
Of course...
> A thought I've had recently is that it could be cool to hack nDoc to
> accept the monodoc xml format as input. There is no reason it
> shouldn't
> be possible as its functionally equivalent to the ms/ndoc format. The
> advantage then is that there are some nice tools for editing
> monodoc and
> we would get the ability to view the nant help in the monodoc
> gui. I'm
> not sure if the monodoc gui is functional on win32 yet but I
> think its
> being worked on.
Mono source code does not contain documentation comments; XML stubs
are generated via reflection with assembler.exe/updater.exe. Miguel
told me that they want to keep user documentation separated from
source code, meaning the /doc feature of the C# compiler is useless...
MonoDoc generates a separate XML file for each *.cs file, while the
C# compiler just put all togheter in a single file. The main
disadvantage of the Mono approach is productivity. I honestly feel
more productive if I write the [english] SDK documentation while
coding, but the way MonoDoc works if more elegant.
I think we should take the best from the two world and finally
offer the killer application for generating SDK documentation.
>
> of course - quite apart from the documentation there is the
> process of
> making internal strings load from a resource file rather than being
> hard-coded to english as they are now.
>
Attached to this email you'll find the RM.cs file, which implements
the localization mechanism. Here below is how to use it:
Old messages (as it is now):
Console.Error.WriteLine("Invalid framework '{0}' specified.",
cmdlineOptions.TargetFramework);
New messages:
Console.Error.WriteLine(RM.GetString("Error_InvalidFramework"),
cmdlineOptions.TargetFramework);
You need a copy of RM.cs for each assembly and you should set the
private field "AssemblyName" to the name of the current assembly.
Let me know if is OK.
j3d.
>
> Ian
>
> >-
> >Giuseppe Greco
> >
> >::agamura::
> >
> >phone: +41 (0)91 604 67 65
> >mobile: +41 (0)79 602 99 27
> >email: [EMAIL PROTECTED]
> >web: www.agamura.com
> >----------------------------------------
> >
> >
> >-------------------------------------------------------
> >SF email is sponsored by - The IT Product Guide
> >Read honest & candid reviews on hundreds of IT Products from real
> >users. Discover which products truly live up to the hype.
> Start reading
> >now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
> >_______________________________________________
> >nant-developers mailing list nant-developers@lists.sourceforge.net
> >https://lists.sourceforge.net/lists/listinfo/nant-developers
> >
> >
>
>
> -------------------------------------------------------
> SF email is sponsored by - The IT Product Guide
> Read honest & candid reviews on hundreds of IT Products from
> real users. Discover which products truly live up to the
> hype. Start reading now.
> http://ads.osdn.com/?ad_id=6595&alloc_id=14396> &op=click
>
> _______________________________________________
>
> nant-developers mailing list nant-developers@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/nant-developers
>
---------------------------------- DISCLAIMER ----------------------------------
This message (including any attachments) is confidential and may be
privileged. If you have received it by mistake please notify the sender
by return e-mail and delete this message from your system.Any unauthorised
use or dissemination of this message in whole or in part is strictly
prohibited. Please note that e-mails are susceptible to change.
Banca del Gottardo (including its group companies) shall not be liable for
the improper or incomplete transmission of the information contained in this
communication nor for any delay in its receipt or damage to your system.
Under no circumstances this message can be considered as a written acceptance
or confirmation of an instruction/order given to Banca del Gottardo.
Instructions and orders cannot be accepted or confirmed via e-mail.
Banca del Gottardo (or its group companies) does not guarantee that the
integrity
of this communication has been maintained nor that this communication is free of
viruses, interceptions or interference.
---------------------------------------------------------------------------------
RM.cs
Description: RM.cs
