[Mono-list] Internal documentation
Lluis Sanchez
lsg@ctv.es
Mon, 13 Jan 2003 12:01:53 +0100
This is a multi-part message in MIME format.
------=_NextPart_000_004C_01C2BAFB.902A8AE0
Content-Type: text/plain;
charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Hi!,
I've read what is in the web about mono documentation, but I think that =
this only aplies to the public API. What about internal classes and =
internal methods? Should those be documented inline in the source files =
or should also use the XML format?
Is there a place to put other internal documents not directly related to =
the API? (for example, about architecture or protocols)
Thanks,
Lluis.
------=_NextPart_000_004C_01C2BAFB.902A8AE0
Content-Type: text/html;
charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=3DContent-Type content=3D"text/html; =
charset=3Diso-8859-1">
<META content=3D"MSHTML 6.00.2800.1126" name=3DGENERATOR>
<STYLE></STYLE>
</HEAD>
<BODY bgColor=3D#ffffff>
<DIV><FONT face=3DArial size=3D2>Hi!,</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>I've read what is in the web about mono =
documentation, but I think that this only aplies to the public API. =
What=20
about internal classes and internal methods? Should those be documented =
inline=20
in the source files or should also use the XML format?</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>Is there a place to put other internal =
documents=20
not directly related to the API? (for example, about =
architecture=20
or protocols)</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>Thanks,</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>Lluis.</FONT></DIV></BODY></HTML>
------=_NextPart_000_004C_01C2BAFB.902A8AE0--