Adding Comments

[Jaysmito101]

Add comments to the header documenting the code.

Note comments must be added using the format specified for doxygen (https://www.cs.cmu.edu/~410/doc/doxygen.html)

[dragon540]

Hey, I want to work on the issue, can I go ahead?

[Jaysmito101]

@dragon540 sure go ahead

[dragon540]

Hey!
How can I compile examples in order to better understand the project and src. Every time I try to compile any example I seem to run into issues with some missing header files or something. It started with "glad.h", then "AL/al.h", then "ft2build.h". I was somehow able to get past them but I am now stuck on missing header "stb_image.h". I have absolutely no experience of working with openGL so apologies in advance if it's a very basic question.
Can you help me with how to setup my system and which all libraries do I have to install in order to make it work?
I am working on Linux Mint 21.

[Jaysmito101]

@dragon540 you will need to install a lot of stuff for opengl development on Linux. Check out https://medium.com/geekculture/a-beginners-guide-to-setup-opengl-in-linux-debian-2bfe02ccd1e

[ghost]

Do assign me this as I can contribute to this issue.

[Bharadwajshivam28]

@Jaysmito101 Assign this to me sir i can complete this issue

[Jaysmito101]

@Bharadwajshivam28 @Shine-Gupta if you are interested in working create a relevant pull request . I will assign after that.

[Bharadwajshivam28]

ok sir @Jaysmito101

[itsrishti]

DO u assign me this project as i want to contribute in this issue

[Bharadwajshivam28]

@Bharadwajshivam28 @Shine-Gupta if you are interested in working create a relevant pull request . I will assign after that.

ok sir

[Bharadwajshivam28]

@Jaysmito101 sir please elaborate this issue as i am not able to get the issue

[Jaysmito101]

@Bharadwajshivam28 as the title says the job is to add comments to the functions in cgl.h to document them. These comments should be proper and descriptive explaining the function, its quirks, parameters, return types, etc.

[Bharadwajshivam28]

ok sir @Jaysmito101

[dragon540]

hey @Jaysmito101, apologies for the delay since last interaction as I was occupied with college and my machine was broke due to some errors. I have installed OpenGL and can run opnegl examples now. But trying to compile cgl examples still throws error like
cgl.h:1966:10: fatal error: AL/al.h: No such file or directory 1966 | #include <AL/al.h> | ^~~~~~~~~ compilation terminated.
Also I have few more queries regarding this project.

1. How is it different from OpenGL itself?
2. Where are the implementation details? "cgl.c" is completely empty so how does the compiler knows what logic to carry out? If we are just calling openGL through cgl(which I learnt is itself just specifications and not the complete logic by itself), I fail to understand the purpose of the project. Also unlike openGL whose implementation is defined at hardware level, where is the implementation detail of cgl is defined?

[Bharadwajshivam28]

@Jaysmito101 Sir i am not able to identify the functions can you just give some hint that which are the functions or can you comment the line color of functions that which color of lines are functions

[Jaysmito101]

@dragon540 cgl's implementation is inside CGL.h itself. The error you get is due to missing openal which is for audio. You have to set it up too. OpenGl is just for low level graphics where as CGL is for a lot lot more.

[Jaysmito101]

@Bharadwajshivam28 take a look in CGL.h everything is in there.

[Bharadwajshivam28]

@Bharadwajshivam28 take a look in CGL.h everything is in there.

Ok sir will do it

[dragon540]

@Jaysmito101 I have installed openal related libraries. But then it showed "ft2hbuild.h" as missing, I could get around that by replacing #include <ft2build.h> with #include <freetype2/ft2build.h>. in cgl.h file. It now throws this error
In file included from cgl.h:9519, from fireworks.c:31: /usr/include/freetype2/ft2build.h: At top level: /usr/include/freetype2/ft2build.h:37:10: fatal error: freetype/config/ftheader.h: No such file or directory 37 | #include <freetype/config/ftheader.h> | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~ compilation terminated.

[Bharadwajshivam28]

@Jaysmito101 sir as much my knowledge i did commenting in functions can you review it so that i can go ahead

[Bharadwajshivam28]

[Bharadwajshivam28]

These are samples sir @Jaysmito101 due to some issue i am not able to change changes please review it here sir

[Jaysmito101]

@Bharadwajshivam28 as far as I can see it's ok but do not use single line comments like this but follow the format for doxygen ( check here https://www.cs.cmu.edu/~410/doc/doxygen.html)

Edit: Try not to add too much in one go. First comment just say about 100 lines and make the pull request. Then after getting that merged continue with another pr. As if you make huge changes in a single pr it will probably not be reviewed in time.

[Bharadwajshivam28]

ok sir @Jaysmito101

[Bharadwajshivam28]

so i am creating first pr beacuse i have done more so

[AbhinavJD7]

Hello, I can try to work on this problem. So ,can you please assign me this project @Jaysmito101

[purbakundu]

i want to contribute

[sagnik3788]

i want to work on this under jwoc