FizzBuzz code need thorough Doxygen documentation

[jayjaybillings]

The project is largely missing API-level documentation and should be updated to use Doxygen. Here is a good resource for that: http://csweb.cs.wfu.edu/~fulp/CSC112/codeStyle.html

Also there are good examples in Fire: https://github.com/jayjaybillings/fire/blob/master/astrophysics/Species.h

[dgquvn]

I tried to add Doxygen documentation. It seems it's not working. Let me know where I set incorrect.

[dgquvn]

Never mind, I think I think it is actually working. I just need to add more comments

[jayjaybillings]

I noticed in main() that you put the documentation before the function declaration. It should go above for it to be scanned by Doxygen and filled correctly.

Congrats on figuring this out though! Doxygen can be tough.

Jay Jay Billings Team Lead, Scientific Software Development Oak Ridge National Laboratory Twitter Handle: @jayjaybillings

---

From: dgquvn notifications@github.com Sent: Tuesday, August 29, 2017 4:30 PM To: dgquvn/repo repo@noreply.github.com CC: "Billings, Jay Jay" billingsjj@ornl.gov,Author author@noreply.github.com Subject: Re: [dgquvn/repo] FizzBuzz code need thorough Doxygen documentation (#14)

Never mind, I think I think it is actually working. I just need to add more comments

- You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/dgquvn/repo/issues/14#issuecomment-325794141, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AGFVYShV50gcaVD4ZOIYD3CdVPbm9z9Aks5sdHTmgaJpZM4PFwKk.

[dgquvn]

I think I have corrected that and made it work, although there might be some warning msg I haven't paid attention to. And I also include the simple OpenMP parrallel for loop

[dgquvn]

I think this should be ok for this ticket and I'll remove the omp_set_num_threads for openmp