Would this be correct?

/** Callback function to pack payload contents from a stream into a buffer
*  so we can report them in JSON output.
*
*/

I see some functions commented simply like that, while others have more information like this one:

/**
* \brief Create a new LogFileCtx for "fast" output style.
* \param conf The configuration node for this output.
* \return A LogFileCtx pointer on success, NULL on failure.
*/

- Matt

From: Victor Julien [mailto:notifications@github.com]
Sent: Monday, April 14, 2014 5:42 AM
To: inliniac/suricata
Cc: Carothers, Matt (CCI-Atlanta)
Subject: Re: [suricata] Json alert packet payload feature 1155 v2 (#922)


In src/output-json-alert.c:

> @@ -70,6 +74,17 @@ typedef struct JsonAlertLogThread_ {

>      MemBuffer *buffer;

>  } JsonAlertLogThread;

>

> +/* Callback function to pack payload contents from a stream into a buffer

Please use doxygen style comments for function headers.

—
Reply to this email directly or view it on GitHub<https://github.com/inliniac/suricata/pull/922/files#r11576857>.