Doxygen output does not display on MAC OSx

Question

Doxygen output does not display on MAC OSx

Closed this issue 4 years ago · 9 comments

I build the doxygen output some months ago on Mac OSx and nothing really displayed from index.html. I ignored it but tried again today with updated everything. Still noting displays but the header, main page tab, Open Model Railroad banner. And that is all. I tried Firefox, Google and the native browsers.

Debug.txt contains
QDir::readDirEntries: Cannot read the directory: /Users/johnSMac/openmrn/applications/async_blink/targets/microchip-pic32mx-generic/misc
QDir::readDirEntries: Cannot read the directory: /Users/johnSMac/openmrn/applications/blink_raw/targets/microchip-pic32mx-generic/misc

and they don't exist. Nothing starting with microchip does.
index.html (converted to .txt just to upload)
index.txt

Answer 1 · 2019-10-31T15:53:36.000Z

The Doxygen based documentation is known to have rotted and needs updating. It has been on our “todo” list for some time.

…

On Oct 31, 2019, at 10:47 AM, JohnFFlanagan ***@***.***> wrote: I build the doxygen output some months ago on Mac OSx and nothing really displayed from index.html. I ignored it but tried again today with updated everything. Still noting displays but the header, main page tab, Open Model Railroad banner. And that is all. I tried Firefox, Google and the native browsers. Debug.txt contains QDir::readDirEntries: Cannot read the directory: /Users/johnSMac/openmrn/applications/async_blink/targets/microchip-pic32mx-generic/misc QDir::readDirEntries: Cannot read the directory: /Users/johnSMac/openmrn/applications/blink_raw/targets/microchip-pic32mx-generic/misc and they don't exist. Nothing starting with microchip does. index.html (converted to .txt just to upload) index.txt <https://github.com/bakerstu/openmrn/files/3794644/index.txt> — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#332?email_source=notifications&email_token=AARMLDQP5YZ2NQRJZT5UI3LQRL4Y3A5CNFSM4JHMLIG2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HV2QYYA>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AARMLDT3L7OL7WL5SXF3NN3QRL4Y3ANCNFSM4JHMLIGQ>.

Answer 2 · 2019-10-31T16:07:55.000Z

I have to be honest, I never liked updating my Doxygen files when I did that. So I certainly understand.
Is there another source of documentation?

Answer 3 · 2019-11-02T18:21:39.000Z

I spent some time and found an issue, the one that blocked me getting any output. In the Mac OSx Doxygen version 1.8.16 a "blank" FILE_PATTERNS does not work It needs to be commented out. I.e.

FILE_PATTERNS =
to

FILE_PATTERNS =

Note spacing is not really correct.

This seems like a Doxygen bug to me. That said, it my have to be fixed in this code for now.

Once you comment on this comment I will close this.

Thanks . John

Answer 4 · 2019-12-12T16:20:04.000Z

@JohnFFlanagan would you like to send us a PR with this fix?

Answer 5 · 2019-12-17T01:06:09.000Z

I spent some time doing both searches and builds. doxygen 1.8.13, which UBUNTU uses with apt-get works correctly. 1.8.16 which I downloaded as the current stable via the gz file fails. It appears the not yet released will fix this and in fact building from the current bleeding edge source works correctly. So I don't know if we should change the Doxyfile to make this work or wait for the correct fix in doxygen. What are your thoughts?

Answer 6 · 2019-12-17T16:48:34.000Z

If there is a small change we can do to our settings that has no detrimental effect but expands compatibility backwards, we should totally do that.

Answer 7 · 2020-07-06T17:55:52.000Z

John,
Would you confirm if this issue is fixed? I see a commit into master for it so would like to confirm with you and if so, ask you to mark this as resolved. Thanks!

Answer 8 · 2020-07-06T18:07:11.000Z

Looks great. Thanks

Answer 9 · 2020-07-06T18:08:20.000Z

My bad, I didn't know I had to do that. I closed it. Next time I will know. Sorry John

…

On Mon, Jul 6, 2020 at 12:56 PM rilull ***@***.***> wrote: John, Would you confirm if this issue is fixed? I see a commit into master for it so would like to confirm with you and if so, ask you to mark this as resolved. Thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#332 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADHWWK5MXXKHITD4DWL2Y73R2IF3NANCNFSM4JHMLIGQ> .