/technologies/code_exchange/b/blog/posts/github-automate-project-documentation-with-doxygen-and-publish-online-after-pushing-commitsThe title says it all. You can generate project documentation from the comments in the source files. I&#39;m using doxygen for that. What I tried today (and succeeded in), is to make a GitHub action that: kicks off a process on one of its...en-USTelligent Community 12https://community.element14.com/technologies/code_exchange/b/blog/posts/github-automate-project-documentation-with-doxygen-and-publish-online-after-pushing-commitsTue, 11 Feb 2025 18:38:08 GMT93d5dcb4-84c2-446f-b2cb-99731719e767:8030ce87-8665-4277-82f8-a94954b8a52eJan Cumps0<p>The GitHub doxygen-action task&nbsp;has a number of versions. Each version matches a DoxyGen document generator version.<br />Since a few weeks, the author created an &quot;edge&quot; version. That one will always install the latest DoxyGen version available.</p> <p>[embed:dc8ab71f-3b98-42d9-b0f6-e21e02a0f8e2:f06c94b0-bbaf-49e6-aff0-3244f6faad8e:type=text&text=%20%20%20%20%20%20-%20name%3A%20Run%20Doxygen%0A%20%20%20%20%20%20%20%20uses%3A%20mattnotmitt%2Fdoxygen-action%40edge%0A%20%20%20%20%20%20%20%20with%3A%0A%20%20%20%20%20%20%20%20%20%20%23%20working-directory%3A%20%27%24%7B%7Bgithub.workspace%7D%7D%2FKerbal%2Fdoxygen%27%0A%20%20%20%20%20%20%20%20%20%20doxyfile-path%3A%20%27Doxyfile%27]</p> <p>At the time of writing, it &#39;ll use DoxyGen 1.13.2</p> <p>The author has added a funny message:</p> <p><img height="221" src="/resized-image/__size/796x442/__key/commentfiles/f7d226abd59f475c9d224a79e3f0ec07-8030ce87-8665-4277-82f8-a94954b8a52e/pastedimage1739299073200v1.png" width="398" alt=" " /></p><img src="https://community.element14.com/aggbug?PostID=28161&AppID=74&AppType=Weblog&ContentType=0" width="1" height="1">https://community.element14.com/technologies/code_exchange/b/blog/posts/github-automate-project-documentation-with-doxygen-and-publish-online-after-pushing-commitsWed, 17 Jul 2024 16:44:02 GMT93d5dcb4-84c2-446f-b2cb-99731719e767:8030ce87-8665-4277-82f8-a94954b8a52eJan Cumps1<p>A side effect of doxygen style commenting (I always forget that until I start writing &quot;for documentation&quot; comments:</p> <p>It gets harder to read the actual source code, to grasp what a class looks like.</p> <p>Before (ignore the colour coding differences - one is from e12 blog, other from VSCode):&nbsp;</p> <p><img alt=" " height="327" src="/resized-image/__size/694x654/__key/commentfiles/f7d226abd59f475c9d224a79e3f0ec07-8030ce87-8665-4277-82f8-a94954b8a52e/pastedimage1721234584037v1.png" width="347" /></p> <p>After:</p> <p><img alt=" " height="576" src="/resized-image/__size/1316x1152/__key/commentfiles/f7d226abd59f475c9d224a79e3f0ec07-8030ce87-8665-4277-82f8-a94954b8a52e/pastedimage1721234618444v2.png" width="658" /></p> <p>What do you think? Is it worth it?</p><img src="https://community.element14.com/aggbug?PostID=28161&AppID=74&AppType=Weblog&ContentType=0" width="1" height="1">https://community.element14.com/technologies/code_exchange/b/blog/posts/github-automate-project-documentation-with-doxygen-and-publish-online-after-pushing-commitsMon, 15 Jul 2024 11:51:51 GMT93d5dcb4-84c2-446f-b2cb-99731719e767:8030ce87-8665-4277-82f8-a94954b8a52eJan Cumps1<p>comments&nbsp;taken over from original forum post:</p> <p><img height="571" src="/resized-image/__size/998x1142/__key/commentfiles/f7d226abd59f475c9d224a79e3f0ec07-8030ce87-8665-4277-82f8-a94954b8a52e/pastedimage1721044162762v1.png" width="498" alt=" " /></p> <p><img height="610" src="/resized-image/__size/996x1220/__key/commentfiles/f7d226abd59f475c9d224a79e3f0ec07-8030ce87-8665-4277-82f8-a94954b8a52e/pastedimage1721044297032v4.png" width="497" alt=" " /></p> <p></p> <p><img height="407" src="/resized-image/__size/996x814/__key/commentfiles/f7d226abd59f475c9d224a79e3f0ec07-8030ce87-8665-4277-82f8-a94954b8a52e/pastedimage1721044209352v3.png" width="497" alt=" " /></p> <p></p> <p></p><img src="https://community.element14.com/aggbug?PostID=28161&AppID=74&AppType=Weblog&ContentType=0" width="1" height="1">