Using Doxygen to document computing projects

preview_player
Показать описание
A brief run through of using Doxygen documentation tool to produce the technical documentation for your computing (F454) and IT (unit 17) projects.

Doxygen will not pick up classes marked internal. So use find and replace (CTRL + F) in VS2015 to find internal and replace with public (make sure the scope is for the entire project). It doesn't matter for what we are doing. You must make sure you do save all after the renaming.

There are other workarounds but this is ok for producing the tech docs for the project.
Рекомендации по теме
Комментарии
Автор

This was super helpful working with Doxygen for the first time! Thank you!!

sanstac
Автор

Always love a simple tutorial video to help me get going. Thanks!

charlesmersereau
Автор

6 years later .. this is still working perfectly !! tks :p cheers from brussels.

Donskippyful
Автор

Good, informative, brief video. THANK YOU SO MUCH!

michaslimak
Автор

Holy shit i love this guy :D i wish i was enrolled in this class this man sounds like he dosen't have a care in the world i love british humor :D but also thanks great informational video

Gogon
Автор

I'm new to Doxygen and I'm a bit confused. It generates code from the comments in header and source files. But is it possible to extend this information some other way? Not only if I need to add diagrams and figures to the documentation, but if I write a whole paragraph for each function in a class then my header file goes from one page, that fits on the screen, to an unreadable 10 pages long code. I wouldn't call good comments "Documentation". How is this usually done?
I could just use a word-processor to do it right, but I'd miss out on the html and pdf output that are so handy. Are there other editors out there for this or does Doxygen go this far itself?

AV
Автор

What's the use of Working Directory which you pointed to folder named "DOX SCRATCH".

winuxworx
Автор

why isn't the run "run doxygen" button available to press it? I've done everything you said.

scienceonly
Автор

Hi I tried this and also checking the recursive tag and the result for me is just the same, it documentates everything inside the folders but not the subfolders which I am also trying to documentate, any hint? thank you very much for your video.

crisme
Автор

Great Video !!

Thank U Very Much Bro !! :D

KistlakRajapakshaSevenNet
Автор

I got an error:
error: Could not open file for writing

jhnjhhhjjhhhhhhh