Comment for ats_base64_ functions seems wrong

[maskit]

The comment says functions return pointers for malloc-ed buffers, but the implementations don't seem like so.

trafficserver/include/tscore/ink_base64.h

Lines 34 to 35 in c196db5

	* These routines return char*'s to malloc-ed strings. The caller is
	* responsible for freeing the strings.

[yozaam]

• These routines convert char*'s to malloc-ed strings. The caller is
• responsible for freeing the strings.

Would that becorrect?

[maskit]

I think the routines do not allocate memory.

[alokrahul513]

Hi, I want to work on this issue. How to get started?

[Sid672]

@maskit can you tell me what changes you want?
Removal of comments or modify them?

[maskit]

If you think the behavior is obvious and the comment is unnecessary, remove it.
If you think documentation is necessary, modify the comment so that it describes the behavior.

I think documentation is always nice to have, but it should not tell a lie if it exists. I'd modify the comment.

Here is the implementations if you need to know what the functions do.
https://github.com/apache/trafficserver/blob/master/src/tscore/ink_base64.cc

[Sid672]

@maskit please correct me if I am wrong.
Functions:

1) bool ats_base64_encode(const char *inBuffer, size_t inBufferSize, char *outBuffer, size_t outBufSize, size_t *length);

2) bool ats_base64_encode(const unsigned char *inBuffer, size_t inBufferSize, char *outBuffer, size_t outBufSize, size_t *length);

3) bool ats_base64_decode(const char *inBuffer, size_t inBufferSize, unsigned char *outBuffer, size_t outBufSize, size_t *length);

• The first function call the 2nd function.
• 2nd function converts the character into binary up to the length of Buffersize and returns true if it is completed.
• 3rd function decode the buffer and returns true after completion.

So can I add these comments:

* These routines convert char's of string and return true. 

[bryancall]

@willwendorfvm Do you want to take a look at this?

[bryancall]

@moonchen is going to take a look at this