I've only used the html pages as I don't use MS word.


Try changing the INPUT_ENCODING to ISO-8859-1 or something compatible.
https://www.gnu.org/software/libiconv/

it works with the html, but I wanted a pdf. I assumed that for 16-bit Unicode I should use UTF-16 but that just generates an error message.
Any other setting makes Ω into Ω
The html looks like a huge muddle of files. I doubt my management would know which one to click on to start. Something they could print out and file would suit them better!

 

You can try using the latex docs to make a unified pdf

For Linux, install: texlive-full
apt-get install texlive-full

Go the latex directory of the doxygen generated files instead of the html directory and type make to create the pdf.

The completed file should be called refman.pdf.

 

You can try using the latex docs to make a unified pdf

For Linux, install: texlive-full
apt-get install texlive-full

Go the latex directory of the doxygen generated files instead of the html directory and type make to create the pdf.
The completed file should be called refman.pdf.

It just complains about not having a font map file (and writes a log file 788 lines long to tell me that).

 

It just complains about not having a font map file (and writes a log file 788 lines long to tell me that).

Works for me but you must install texlive-full, first.

root@maint9:~/ha_energy/bmc/latex# make >lo
This is makeindex, version 2.17 [TeX Live 2025/dev] (kpathsea + Thai support).
Scanning input file refman.idx....done (895 entries accepted, 0 rejected).
Sorting entries..........done (9336 comparisons).
Generating output file refman.ind....done (1344 lines written, 0 warnings).
Output written in refman.ind.
Transcript written in refman.ilg.

list output of the make command and resulting pdf file.

 

Have you made progress on generating the pdf or rtf output?

 

Have you made progress on generating the pdf or rtf output?

On advantage of having two computers.. . .
I installed texlive on the one at work, and it worked - no complaints about the fonts.
(The one at work refused to load the latest version of Doxygen, and installed the previous one, but it works).
I can get rtf output, and pdf either via Open Office writer, or via Latex and texlive.
They both make a mess of unicode characters, but in two different ways!
A long conversation with the Doxygen author on GitHub followed, after which I now have unicode characters wrong in three different ways.

 

What distribution do you use? Perhaps it has a pre-compiled doxygen package that 'just works'.

 

When something is critical to a software project I sometimes build my personal copy so I don't depend on the distro version that might be far behind the current release in fixes and improvements.

https://github.com/doxygen/doxygen?tab=readme-ov-file
https://www.doxygen.nl/manual/install.html

I also compiled the latest GUI frontend for Doxygen.




Make the refman.pdf in the latex directory.
Open refman.pdf in firefox

main logtime call graph

energy.h include graph

HA_ENERGY program active run log.



Home Assistant control panel using the HA_ENERGY and other data streams, mainly using MQTT as the communications sharing method.

 

I note that you have some sections of code within your documentation. How do you tell it to do that?
When it documents a file, it lists the functions first as a kind of index, then below that goes into more detail.
I get an entry in the "index" if I put a comment before the first { and in the detail if I put it after, though it would make more sense if it repeated the first one at the beginning of the detail.

 

I note that you have some sections of code within your documentation. How do you tell it to do that?
When it documents a file, it lists the functions first as a kind of index, then below that goes into more detail.
I get an entry in the "index" if I put a comment before the first { and in the detail if I put it after, though it would make more sense if it repeated the first one at the beginning of the detail.

I'm using the Wizard to generate documents from the command line. The doxygen version is the latest from github compiled on my workstation.



cross-referenced source code in the output.

 

Just how does one document software?
I'm a complete autodidact when it comes to software, but I've been writing microcontroller software for most of my career, and no-one has ever has asked me to document it. Now, I'm thinking of retiring within the next few years and whilst I could behave like a complete bastard and just leave my successor to sort out the mess, I'm not that sort of bloke; and perhaps it really should be properly documented now.
Whilst I might like to think that I write perfectly lucid code that is perfectly obvious to anyone reading it what it does, that might just be a matter of opinion; so, are there standardised ways of documenting C, beyond writing the odd comment line? To what level of granularity should it be explained?
And how? In natural language or by flowchart?

Get the original requirements, the input documents that drove the creation of the software. If your code implements already documented requirements then you're halfway there. You could annotate bits of the code too with references to the requirements as well like "This file implements section 3 of chapter 2" and so on.

Any material that fed into the writing of the code will be very helpful, whether its requirements or logical design and so on.