Erste Teile der Dokumentation online

Erste Teile der automatisch generierten Dokumentation sind nun online verfügbar. Es handelt sich dabei bisher nur um die API-Dokumentation der IRC-Protokoll-Schicht.
Added by Markus Andree about 1 year ago

Die IrcSharp-Library ist im aktuellen Entwicklungsstand am weitesten ausgebaut und kann bereits verwendet werden. Daher steht nun auch die Dokumentation für diese Library zur Verfügung. Für die anderen Bestandteile von IrcShark gibt es aktuell noch keine fertige Dokumentation, da an einigen Stellen noch Kommentare fehlen. Sie wird jedoch auch zur Verfügung stehen sobald diese fehlenden Teile entsprechend nachgebessert wurden. Die Dokumentation ist aktuell nur als Website verfügbar, jedoch wird auch an der entsprechenden Dokumentation im Help 2.0 Format gearbeitet, wodurch sich die Hilfe auch in SharpDevelop und Microsoft Visual Studio einbinden lässt. Zur Generierung wurde Sandcastle eingesetzt. Als Hosting-Server dient hier XSP2. Sollte es Probleme mit der Dokumentation geben, steht im Bug-Tracker eine entsprecehnde Komponente bereit, um diese zu melden.

Mit freundlichen Grüßen,
euer IrcShark-Team.


Comments