#Doxygen csharp archive

Once you have your code ready to be deployed, you can create a new git orphan branch and remove everything in the branch. Protected Span GetStructureBytesFromOffset(Int64 offset) where T : struct / The location of the structure in the memory stream. / The Type of the structure to extract from the memory stream. / Extract the byte representation of a structure from the memory stream. In my case, I used the XML documentation comments, as recommended by Microsoft for C# projects.Įxample of method documentation using the XML documentation comments in C# Note that Doxygen support multiple languages like, C, C++, C# and even Python (gross). You can find an example with this project: įirst, you need to properly comment your code with notations that can be parsed by Doxygen. Second one will deploy the HTML documentation to a GitHub page to make the documentation public. one will be used to generate the HTML documentation by parsing the source code with Doxygen.

#Doxygen csharp archive

To archive that, I am using the following GitHub Actions: In our case we will have one job with two tasks. My plan was to use GitHub Actions to automatically generate and deploy Doxygen documentation when I push code to a master branch. For each workflow you can define custom jobs and tasks. GitHub Action is awesome because this allow developers to create custom software development life cycle (SDLC) workflows, directly from GitHub.

I have subscribed to a professional GitHub account few weeks back, which gave me access to the 3000 minutes of GitHub Actions per months. I'm probably not a great programmer but a least I'm documenting my code! Trust me, well documented code will save your butt. I used to be a Java/PHP/PolymerJS developer for 2 years before joining the wonderful information security industry and developing in C/C++ and C#.