doxygen

Never worry about Docs again! Automate it with CMake instead

Automating CFD solver and library compilation using CMake / By

In this article, we will talk about the d word again; documentation. I know, most developers find open-heart surgery more appealing that having to write documentation for their own code, but it is an integral part of software engineering and ensuring other users can work with your software. I wouldn’t do you a favour by …

Never worry about Docs again! Automate it with CMake instead Read More »

How to annotate C++ code for automatic code documentation

Keep your users happy: how to document code the right way / By

In this article, we look at how we can annotate our code so it can be picked up by a documentation tool to provide automatic code documentation for us. There are good and bad ways to do this, and unfortunately, more often than not, code documentation is a dreaded task by programmers and is done …

How to annotate C++ code for automatic code documentation Read More »