Doxygen Basics

[@srz4720]

By far one of the best tutorials I have ever seen. Thanks a lot :)

[@Abdullah-mg5zl]

Not a problem! Thank you very much!

[@alexandrostsagkaropoulos]

I just learned about this and I'm in awe. I was wondering why anyone wasn't built anything like that, but I was wrong. Also, the simple, yet elegant, explantation helped get things straight in my mind about how to use this tool. Great tutorial!

[@belkissjebali7153]

You actually saved my life with this tutorial !! Thank you very much !! Keep up the good work ! Thanks again from France ^^

[@Abdullah-mg5zl]

Not a problem! Glad I was able to help

[@alonsojimeanch]

Thank you so much for doing this, helped me a lot for college. The lesson is clear and I also agree with your non-blindy following lessons method, It gets ride of unnecesary doubts.

[@Abdullah-mg5zl]

No problem man. Yeah I'm not a fan of simply following recipes, understanding is much more fruitful and fun.

[@Colaholiker]

That was a great tutorial, thanks a lot! Until now, we haven't used anything like this at my workplace, all "code documentation" was just comments in the source file, which as a maintenance nightmare (yes, those places *do* exist). For new projects we were looking into something that helps a lot without too much extra effort, and that is Doxygen. :)

[@Abdullah-mg5zl]

Excellent! Doxygen is the standard tool for documenting C/C++ source. For other languages, they have their own standard tools (e.g. sphynx for python)

[@Colaholiker]

@@Abdullah-mg5zl It's C, so Doxygen seems to be perfect. However, it requires some tweaking if you work on the lowest level in an embedded system design with all the registers and bit definitions to get something that is usable. ;-) But hey, if that microcontroller has 2000+ pages of datasheet nobody expects things to so easy. :-D

[@rutujawattamwar5132]

It feels like easy peasy lemon squeezy after watching your video. Great demonstration!

[@Abdullah-mg5zl]

Hahaha great to hear, thanks man!

[@altafnavalur4808]

Excellent. Great video. Saved a lot of time looking around

[@Abdullah-mg5zl]

Awesome! Glad to have helped

[@JustinPierce01]

Great tutorial -- I do appreciate you giving personal best practice tips.

[@Abdullah-mg5zl]

Yeah no problem, glad they helped ya

[@olegtschaikowsky8030]

Hi, really very good tutorial - enough to understand how it works and enough to start with Doxygen!!! Thank you very much dude!

[@Abdullah-mg5zl]

Not a problem!! Very glad that it was helpful to you!

[@loriboyters4171]

agree, doxygen is the best tool for generating software documentation in html and pdf (using latex). It also works great with other code like Java, or even NO CODE. I've generated many types of documents using doxygen for over 10 years.

[@ZonaGeeWon]

fantastic video! appreciate the video length and time taken to explain why and not just how.

[@Abdullah-mg5zl]

You're very welcome!

[@cronos864]

Great video! Very informative with good pacing and great clarity. Thanks!

[@Abdullah-mg5zl]

Thank you, I appreciate it!

[@mariorossi7930]

Hi, I really appreciate how you presented: complete but not too long. Do you plan to make a video about test frameworks (e.g. Catch2)?

[@Abdullah-mg5zl]

Hello! Thank you! Yes, that's a GREAT idea, I LOVE that test framework for C++! I'll work on releasing that by the end of this weekend (sunday), latest, maybe earlier if I can find some time during the next few weekdays. :) And thank you for the feedback, I really appreciate that!

[@mariorossi7930]

No rush :) Thank you for your work.

[@manojprabhakar3114]

This tutorial is so good. Could you please make a tutorial on doxygen along with graphviz and plantuml if possible?

[@Abdullah-mg5zl]

Thanks! It's pretty easy to use graphviz and plantuml with doxygen! You just need to download/install the respective tool and then tweak some settings in your doxyfile! To use graphviz, just download/install graphviz, then set the HAVE_DOT setting to yes. Read here for more: www.doxygen.nl/manual/diagrams.html To use plantuml, make sure you install Java and then download the plantuml JAR file. Make the PLANT_UML_JAR_PATH point to where you placed your plantuml JAR file. Read here for more: www.doxygen.nl/manual/commands.html#cmdstartuml As you see from the link above, you can put your plantuml code between @startuml and @enduml commands.

[@mano6992]

@@Abdullah-mg5zl Thank You

[@eliaszeray7981]

Thank u a lot. I appreciate sharing your knowledge.

[@Abdullah-mg5zl]

No problem! Thanks for watching and have a great week!

[@vitordesiqueira2117]

Great work! -Thanks from Brazil

[@Abdullah-mg5zl]

Thanks man, appreciate it! Have a good weekend!

[@baristuncer7597]

Thanks much Abdul for this beautiful presentation!

[@Abdullah-mg5zl]

Not a problem!

[@SanjivKBhatia]

Great job. I had to pause to see a couple of things, like how you created a class. I hope you have a tutorial on adding md files to Visual Studio.

[@Abdullah-mg5zl]

Thank you! I usually don't use Visual Studio to write my .md files. I use VSCode, which is personal favorite text/code editor (it's not a full fledged IDE like the traditional visual studio).

[@SanjivKBhatia]

@@Abdullah-mg5zl No problem. You did a wonderful job on doxygen and I scanned your other tutorials. At least I learned about looking for markdown files :-)

[@Bbdu75yg]

Amazing tutorial thank you very much !!! Awesome !!! I have wanted to learn this for a lot of time !!

[@Abdullah-mg5zl]

Not a problem!! Glad you enjoyed it

[@amirreza813]

Thank you. Your video was so helpful for me.

[@hrotter7]

Very good introduction. Thanks a lot!

[@Abdullah-mg5zl]

No problem!

[@DustinGunnells]

This is Awesome and comprehensive!!!!!!!

[@Abdullah-mg5zl]

Thank you! Glad you liked it!

[@nathiyaas9713]

Very informative and very good way of presenting the content!

[@Abdullah-mg5zl]

Thanks!!

[@filippo7349]

Great tutorial! I feel inspired to make some docs, thanks!

[@Abdullah-mg5zl]

Awesome!! And thank you!

[@bluehornet6752]

Great tutorial, thanks. It would have been easier to read your comments though, had you used either a different font color for comments...or (better yet) just used a light theme for the IDE. Other than that though it was very helpful, so thank you for making it.

[@Abdullah-mg5zl]

No problem! Thanks for the feedback! I'll focus on fonts (big/clear to read) in future tutorials

[@Avinash3814]

You are a true Tech Wizard

[@Abdullah-mg5zl]

Thank you!

[@caiodutra9635]

this is really helpful dude! Thanks a lot for taking the time to spread your knowledge on this. I really appreciate it. s2

[@SaifUlIslam-db1nu]

Hi, man! Thank you! This was quick and easy to get.

[@Abdullah-mg5zl]

Not a problem! Have a good weekend!

[@SaifUlIslam-db1nu]

@@Abdullah-mg5zl hahaha, thank you! Same for you as well.

[@sagarwalishetti9103]

This is really nice thank you.

[@coenfuse]

Simply great stuff man! Thank you so much. As a side note, be easy with your keyboard lol

[@shankarbt6680]

Hi, on what command did u open the "Doxygen GUI Frontend". How to open that window. I have isntalled the Doxygen Documentation Generator extension.

[@shohruh9841]

This was very helpful, thanks.

[@Abdullah-mg5zl]

Not a problem!

[@davidbenedetti4961]

Great tutorial! Thank you! :)

[@Abdullah-mg5zl]

Not a problem!

[@TheRabbittz]

what is the best way to share the documentation to others... embed the docs in your source code? just place entire HTML and put in gitlab/github?

[@Lorenz_weez]

Realy nice tutorial, it helped me alot, thank you.

[@Abdullah-mg5zl]

No problem!

[@jayasankagamage1081]

Thanks for this tutorial. It is really nice

[@Abdullah-mg5zl]

No problem, thanks for watching

[@whoisthiswho4070]

I would like to know the name of the vs code extension that helps you generate separate h and cpp files, thanks

[@Mhm_Rhm]

It really helped. Thanks.

[@Abdullah-mg5zl]

No problem!

[@Tsskyx]

How do I turn on the @ syntax highlighting like you did?

[@Abdullah-mg5zl]

I believe that is provided by the Resharper C++ plugin for visual studio. Just install the plugin and you'll get that.

[@rumpelstiltskin449]

5:32 - nice logo!

[@gunasekaran-op8kn]

thanks for your clear explanation..........!!! Don't consider viewer attention time... concentrate on your content like this vide

[@Abdullah-mg5zl]

No problem! Yeah, I don't really care about views lol

[@xyzw1850]

how that doxyfile got created at last...which yoou ran in command prompt?

[@aimenakrouf1972]

Thank you so much, very useful tutorial !

[@Abdullah-mg5zl]

Not a problem!

[@denibegaj4564]

Thank you for the explanation!

[@Abdullah-mg5zl]

Not a problem!

[@adeeljalil1589]

great logo created in 2secs

[@saeidsaati4021]

Great explanation, thank you so much.

[@Abdullah-mg5zl]

You are very welcome! Thank you for watching!

[@karthicks4551]

Thank you so much for your tutorial. Can u plz explain how to include tables in doxygen documentation. I m new to doxygen and trying to generate static view(table). Could u help me on this. Thanks in advance.

[@Abdullah-mg5zl]

You can include markdown in your comments. Google "markdown" table and you'll see the syntax for putting a table in markdown :)

[@johnfang4470]

great video!

[@Karuska22ps]

Can you add class definitions and bodies to Sphinx doxygen?

[@shashu1999]

Nice tutorial. Thanks! Saw that you were a yellow jacket haha

[@midow7127]

Doxygen html output doesnt even look like yours.... dont know whats the problem. he cant find some files when i open it with chrome and listing the network logs

[@MiroGregorovic]

a good intro and Go Jackets! #GeorgiaTech

[@Sonatarium]

I tried it dozens of times, but I am missing the "classes" category in the html. Header comment \file is the same name as the source code, destinations are correct. What am I missing?? Any suggestions?

[@Abdullah-mg5zl]

Check the following: Each one of your files that has a class, has a "@file " somehwere in the file. Doxygen will only check files that have the above.

[@EngMohannad1]

I get confused sometimes about how to use the doxygen of some projects. There is no description of the APIs, which confuses, the header of the APIs is only provided. Let's take LLVM as an example. llvm.org/doxygen/index.html can you elaborate about how to get the most out of such documentation

[@Abdullah-mg5zl]

That's an excellent question! Let's distinguish between "how to/tutorial" vs "class/function" documentation. As you know, "how to" or "tutorials" don't describe how to use every class, or every method of every class. Instead, they tell you how to achieve a higher level goal (e.g. how to build llvm"). "class/function" documentation documents the inputs/outputs of every class/method. You can use Doxygen to generate HTML pages (and other formats) from both types of documentation. To have Doxygen extract class/function documentation, just put comments above your classes/functions, in the source, as we showed in the video. To have Doxygen generate "how to/tutorial" documentation, just create a bunch of .md pages with your tutorials. You can mess with Doxygen's settings to organize these pages and generate links to them in your HTML page's navigation. The LLVM documentation that you linked to me seems to only be class/function level documentation. So what you'd want to do here is find a certain class or function, and read the description of that class and or function. The navigation features of the HTML page allows you to do this. The easiest way would be to search for the class/function you want to look up, in the search bar. Unfortunately, the LLVM documentation has not enabled doxygen's search feature! So, the next best thing is to click on "classes" on the navigation, and find your class alphabetically. Hope that clarifies things a little!

[@arunayachith477]

very nicely done

[@Abdullah-mg5zl]

Thanks!

[@IrfanPratama-mj1iw]

Hi there nice video, but when i try to use the command doxygen on command prompt, an error occurs "'doxygen' is not recognized as an internal or external command, operable program or batch file." i have doxygen installed so i don't know what is wrong. could you help me please regarding this

[@loriboyters4171]

better to create a batch file that calls doxygen.exe at the location where it was installed.

[@doodboy100]

Man he just slaps that keyboard

[@Abdullah-mg5zl]

LMAO hahaha, ayeee I got a new keyboard (much quieter) so that shouldn't be an issue in my future videos my fingers are just too bufffff

[@ayeshamuryam9281]

good work. Can you provide me the link where from you download the visual studio?

[@Abdullah-mg5zl]

If you Google "download visual studio community" the first link should guide you through it. It's very easy. Make sure you download community edition.

[@Michalszczepanski91]

Great tutorial, thank you

[@Abdullah-mg5zl]

No problem !

[@nivo6379]

سپاس فراوان. بسیار عالی و مفید!

[@Abdullah-mg5zl]

No problem! Thanks for watching and hope you have a great weekend!

[@gregwoolley]

Very helpful, thank you!

[@Abdullah-mg5zl]

No problem!!

[@34torba]

Hello, i was wondering if you could help me with this problem i encounter. Doxygen does not generate_treeview for me, whatever i may change in the wizard nothing changes to the html

[@loriboyters4171]

The default setting in the doxygen config file to generate the tree is NO, so you need to change it to YES, then set the value width under TREEWIDTH for how wide you want the tree to be, such as 100.

[@tryingtocorrect]

How do you get the VS to works with the Doxygen, the text editor. Did you download an extension?

[@Abdullah-mg5zl]

Hello! I did not download any doxygen specific extensions for Visual Studio (the IDE) or Visual Studio Code (the text editor). Doxygen works regardless of what IDE or text editor you are using. It just needs text files that are either commented C++ source code, or markdown.

[@tryingtocorrect]

@@Abdullah-mg5zl like when you press enter it puts /// on your editor. What causes that? does it come after I install the Doxygen automatically?

[@Abdullah-mg5zl]

Installing doxygen does not cause that. Either that behavior comes with visual studio (I have VS 2019) or with the Resharper extension that I have installed.

[@marcoburkhardt6496]

very nice !!

[@MrTalJacob]

Amazing!!!

[@Abdullah-mg5zl]

Thanks!

[@dumspirospero9263]

Great tutorial

[@Abdullah-mg5zl]

Thanks!

[@ChoiBoiMax]

Couldn't use the @note,@attention and so on features. Any help please?

[@Abdullah-mg5zl]

Hmmm, did you just do "/// @note some notes here..."? I can't see why it wouldn't work. Can you show me the file that you used it in?

[@Warwipf]

thanks for this, it helped

[@Abdullah-mg5zl]

No problem!

[@ak.karimzai]

bat/cmd/sh how to generate this files from doxygen wizard?

[@Abdullah-mg5zl]

Hello Ahmad! I'm not sure I quite understand your question, see if the following helps: You run the "doxygen" command line program on your "doxyfile" to generate your documentation. You can create/edit the doxyfile using the doxygen GUI or manually using a text editor (I highly recommend using the GUI). You can also run doxygen on your doxyfile via the GUI by clicking on the "Run" tab, and then "Run doxygen" button. Does that help?

[@Abdullah-mg5zl]

@@ak.karimzai just call "doxygen " in your shell script.

[@ak.karimzai]

@@Abdullah-mg5zl oh, thanks

[@malbolgee]

how about documenting members of a struct? :/

[@Abdullah-mg5zl]

Document structs the same exact way you document classes. Nothing changes.

[@MohamedAbdEl-Naby]

awesome. Thank u

[@Abdullah-mg5zl]

Not a problem! Thanks for watching and hope you have a wonderful new year!

[@somasekhar729]

Make a video for Linux users pls, use a c language code for doxygen

[@Abdullah-mg5zl]

Dozygen has the same syntax with C and C++. There Linux binaries also have the same GUI and command line tools so nothing changes :)

[@somasekhar729]

@@Abdullah-mg5zl thanks for the reply, I am getting some errors while downloading the package on terminal, it would be great if you could help here, in case if you are aware of the linux environment, any thanks again for your reply

[@bimDe2024]

if the project is a cmake project, then?

[@Abdullah-mg5zl]

That doesn't make a difference, still comment the same way

[@matthewwright3936]

Watching the LaTeX folder get deleted hurt my soul...

[@mohammadrezaqasemimadani1055]

awesome ;). viva persian. keep going .

[@vivek.poovathoor]

Shoutout to Buzzport and Canvas

[@Abdullah-mg5zl]

HAHAH is that where you found my channel!? EDIT: OHHH nah, you saw my favorites in the video :P

[@ivanserrano5511]

Saludos al que venga para la práctica de PRO2

[@lubeda04]

Helpfull!

[@dangcan1215]

thank you verymuch

[@Abdullah-mg5zl]

no problem!

[@Manas-co8wl]

Thank you

[@Abdullah-mg5zl]

You're welcome

[@shenaniganscentralclips]

love from nepal

[@Abdullah-mg5zl]

Thank you! Nepal seems like a beautiful place and I'm certain the people are amazing. Have an awesome day!

[@guilhermedantas5067]

The keystrokes were really annoying.

[@Abdullah-mg5zl]

Agreed. This was with my old keyboard. I've since bought a newer (and much quieter) keyboard. But the loud keys make you feel like you're SUUUUPPPER productive!!

[@guilhermedantas5067]

@@Abdullah-mg5zl Hahahah fair enough

[@rashedazad]

I wish I could give 10 more likes.. ;)

[@Abdullah-mg5zl]

Hahahah :P. Thanks for watching, hope you have a great week!

[@shrivatsankchari1729]

The keyboard really triggers my misophonia please get rid of it if at all possible

[@Abdullah-mg5zl]

Lol I actually did replace it with a quieter one, as you'll see in my more recent tutorials

[@TheDedictvi]

the audacity of the devs to put "donate" button on their mainpage. They should be paying me for using their terrible software.