[Mono-dev] Documentation synchronization

[Rafael Teixeira]

If you properly update your monodoc data, you see it as tooltips
inside MD, or in the Help tree of MD. Also you can edit it in the
MonoDoc viewer, but I'm not sure if you can do the same inside MD,
what surely would be a good thing to have implemented in the near
future.

:)

On 9/15/06, Jacob Ilsø Christensen <jacobilsoe at gmail.com> wrote:
> On 9/15/06, Rafael Teixeira <monoman at gmail.com> wrote:
> > Few doc pages where translated so far (I know about the pt_BR effort),
> > but the structure allows it in an easier fashion than trying to put
> > all translations inside the source code.
> >
> > Another advantage is that as the xml files are
> > created/updated-only-as-needed from reflecting on the binaries,
> > one-file per class per translation, it is easier to maintain them in
> > sync inside a version-control system (SVN in this case), and merge the
> > fill-the-skeleton-in work from contributors and translators.
> >
> > :)
>
> Yes, I see the advantages. So once more out of curiosity. :-)
>
> How do you do practical development? Do you just have a browser in
> another window to show you documentation or?
>
> Maybe a feature could be added to MonoDevelop allowing the
> documentation to be shown along with the source code. This "virtual"
> documentation should be read-only of course. If you wanted to update
> it you would have to change the xml file.
>
> /Jacob
>
> >
> >
> > On 9/15/06, Jacob Ilsø Christensen <jacobilsoe at gmail.com> wrote:
> > > Hi.
> > >
> > > On 9/15/06, Michael Schurter <michael at synthesyssolutions.com> wrote:
> > > > Hi Jacob,
> > > >
> > > > Jacob Ilsø Christensen wrote:
> > > > > Hi again.
> > > > >
> > > > > Just out of curiosity. Why was this documentation approach chosen as
> > > > > opposed to e.g. source code doc comments?
> > > > >
> > > > > A big advantage of source code doc comments is that they are available
> > > > > as you do the actual coding. With the current approach you have to
> > > > > look in a separate xml file to see documentation for a specific class
> > > > > or method or did I miss out on something?
> > > >
> > > > If I remember correctly its to make translation easier.  Please don't
> > > > top post.
> > > >
> > >
> > > So code documentation is actually translated in mono?
> > >
> > > /Jacob
> > > _______________________________________________
> > > > Mono-devel-list mailing list
> > > > Mono-devel-list at lists.ximian.com
> > > > http://lists.ximian.com/mailman/listinfo/mono-devel-list
> > > >
> > > _______________________________________________
> > > Mono-devel-list mailing list
> > > Mono-devel-list at lists.ximian.com
> > > http://lists.ximian.com/mailman/listinfo/mono-devel-list
> > >
> >
> >
> > --
> > Rafael "Monoman" Teixeira
> > ---------------------------------------
> > "The reasonable man adapts himself to the world; the unreasonable one
> > persists in trying to adapt the world to himself. Therefore all
> > progress depends on the unreasonable man." George Bernard Shaw
> >
>


-- 
Rafael "Monoman" Teixeira
---------------------------------------
"The reasonable man adapts himself to the world; the unreasonable one
persists in trying to adapt the world to himself. Therefore all
progress depends on the unreasonable man." George Bernard Shaw