Functiedocs toevoegen met XML

[Thom2503]

Dit is voor iedereen, misschien iets om op de achtergrond ook te doen, maar het is handig om overal waar methods staan functie docs te schrijven. Dus gewoon uitleggen in 1 zin wat de functie doet, met misschien een voorbeeld er bij.

/// <summary>
/// functie om 2 generic variables bij elkaar op te tellen.
/// </summary>
public T Add<T>(T first, T second)
{
    return first + second;
}

[Thom2503]

Weet trouwens niet of je automatisch closen van issues kan uitzetten wat hier niet zou moeten want dit is meer naslagwerk of iets wat je ff snel tussendoor commit.

[Peredurz]

Volgensmij gebeurt dat closen alleen als je iets doet met een commit en dan zegt #(number) is done etc.

[Thom2503]

Ja dat had Jurn uitgelegd ja maar het is misschien wel handig om het op een manier zeg maar aan te geven dat je naslagwerk doet voor deze issue.

[Thom2503]

Misschien als je iets commit wat met deze issue of een andere issue die niet gelijk moet closen iets van prefixen met [issue:19] en dan je commit message.

[Peredurz]

https://www.doxygen.nl/download.html, Dit is de website om Doxygen te installeren om goede documentatie te schrijven. Als je dit zelf wil installeren moet je naar beneden scrollen en bij de Sources en Binaries klikken op jouw operating system.

[Peredurz]

De docs kan je nu ook bekijken op deze website: https://peredurz.github.io/ProjectB/ . Deze website hebben Thom en ik uren aan gezeten om het werkende te krijgen. Met bloed zweet en tranen

[Thom2503]

Oh ja, dus nu kan je voor de gedeeltes die /jij/ hebt gemaakt functie docs toevoegen, kijk ff bij PresentationLogic.cs hoe dat moet. En commit dat dan in de documentation branch, geef daarbij in de commit aan dat het voor deze issue is door [issue:19] te prefixen voor je commit message.

[Peredurz]

Je moet zelf de docs html lokaal bouwen met DoxyWizard met de Doxyfile die in de Documentation branch staat. Je moet zelf dan nog aangeven wat de working Directory van doxywizard is. Maar dan wordt er automatisch html code voor de github pages site gegenereerd. Als je dit vervolgens pusht wordt er door github actions automatisch de website gepubliceerd