Added comments in functions in cgl.h file in my own terms

[Bharadwajshivam28]

@Jaysmito101 I have added comments sir in my own words till some lines

[Bharadwajshivam28]

@Jaysmito101 I have added comments sir

[Bharadwajshivam28]

@Jaysmito101 Please review it and merge it sir so i will move forward to next lines

[Jaysmito101]

As I already said comments should be in the format for doxygen check https://www.cs.cmu.edu/~410/doc/doxygen.html

[Bharadwajshivam28]

ok sir

[Bharadwajshivam28]

@Jaysmito101 sir please elaborate this line

[Bharadwajshivam28]

As I already said comments should be in the format for doxygen check https://www.cs.cmu.edu/~410/doc/doxygen.html

or just drop a sample sir it will help me alot @Jaysmito101

[Jaysmito101]

@Bharadwajshivam28 check out the link i provided

[Bharadwajshivam28]

i checked sir but i am little bit confused

[Bharadwajshivam28]

so please drop sample or elborate sir it will be great for me @ja'

[Bharadwajshivam28]

getting guidance under you will be great sir @Jaysmito101

[Jaysmito101]

@Bharadwajshivam28 A simple example would be:

/** @brief Query system for addrinfo
 * 
 * This function queries the system for addrinfo
 * for the given name and port. The addrinfo is
 * stored in the CGL_net_addrinfo struct.
 * 
 * @param name the name of the host
 * @param port the port of the host
 * @param count the number of addrinfo returned (output)
 * @return the addrinfo of the host 
*/
CGL_net_addrinfo* CGL_net_addrinfo_query(const char* name, const char* port, size_t* count);

Remember you would have to elaborate the functions purpose properly. Also, I would strongly advice going through the entire source of the function, understand it, only then try to describe it. Otherwise it will have mistakes and your effort will be wasted.

[Bharadwajshivam28]

ok sir @Jaysmito101

[Bharadwajshivam28]

@Jaysmito101 sir please review

[Bharadwajshivam28]

its in my own terms and languages and also in correct format

[Bharadwajshivam28]

If you agree then will move forward

[Bharadwajshivam28]

ok