Commit e119b208 authored by Mikhail Karpenko's avatar Mikhail Karpenko
Browse files

Minor updates to doxygen documentation

parent 2f60099a

Doxyfile

+1 −1
Original line number Original line Diff line number Diff line
@@ -371,7 +371,7 @@ INLINE_GROUPED_CLASSES = NO 
# Man pages) or section (for LaTeX and RTF).

# Man pages) or section (for LaTeX and RTF).

# The default value is: NO.

# The default value is: NO.





INLINE_SIMPLE_STRUCTS = NO

INLINE_SIMPLE_STRUCTS = YES





# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or

# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or

# enum is documented as struct, union, or enum with the name of the typedef. So

# enum is documented as struct, union, or enum with the name of the typedef. So

camogm.c

+101 −100

File changed.

Preview size limit exceeded, changes collapsed.

camogm_jpeg.c

+2 −2
Original line number Original line Diff line number Diff line
@@ -53,12 +53,12 @@ int camogm_start_jpeg(camogm_state *state) 
	int rslt;

	int rslt;





	if (!state->rawdev_op) {

	if (!state->rawdev_op) {

		strcpy(state->path, state->path_prefix); //!make state->path a directory name (will be replaced when the frames will be written)

		strcpy(state->path, state->path_prefix);   // make state->path a directory name (will be replaced when the frames will be written)

		slash = strrchr(state->path, '/');

		slash = strrchr(state->path, '/');

		D2(fprintf(debug_file, "camogm_start_jpeg\n"));

		D2(fprintf(debug_file, "camogm_start_jpeg\n"));

		if (slash) {

		if (slash) {

			D3(fprintf(debug_file, "Full path %s\n", state->path));

			D3(fprintf(debug_file, "Full path %s\n", state->path));

			slash[0] = '\0'; //! truncate path to the directory name

			slash[0] = '\0';                       // truncate path to the directory name

			D3(fprintf(debug_file, "directory path %s\n", state->path));

			D3(fprintf(debug_file, "directory path %s\n", state->path));

			rslt = mkdir(state->path, 0777);

			rslt = mkdir(state->path, 0777);

			D3(fprintf(debug_file, "mkdir (%s, 0777) returned %d, errno=%d\n", state->path, rslt, errno));

			D3(fprintf(debug_file, "mkdir (%s, 0777) returned %d, errno=%d\n", state->path, rslt, errno));

camogm_mov.c

+2 −2
Original line number Original line Diff line number Diff line
@@ -311,7 +311,7 @@ int parse_special(void) 
	// a hack - invlude length'skip if data position (header size is known and there is a gap)

	// a hack - invlude length'skip if data position (header size is known and there is a gap)

	if (strcmp(str, "data_size") == 0) {

	if (strcmp(str, "data_size") == 0) {

		gap = headerSize - lseek(ofd, 0, SEEK_CUR) - 8;

		gap = headerSize - lseek(ofd, 0, SEEK_CUR) - 8;

		if (gap > 0) { //!it should be exactly 0 if there is no gap or >8 if there is

		if (gap > 0) { //it should be exactly 0 if there is no gap or >8 if there is

			D4(fprintf(debug_file, "Inserting a skip tag to compensate for a gap (%d bytes) between the header and the frame data\n", gap));

			D4(fprintf(debug_file, "Inserting a skip tag to compensate for a gap (%d bytes) between the header and the frame data\n", gap));

			if (gap < 8) {

			if (gap < 8) {

				D0(fprintf(debug_file, "not enough room to insret 'skip' tag - %d (need 8)\n", gap));

				D0(fprintf(debug_file, "not enough room to insret 'skip' tag - %d (need 8)\n", gap));
@@ -321,7 +321,7 @@ int parse_special(void) 
			putBigEndian(gap, 4);

			putBigEndian(gap, 4);

			D4(fprintf(debug_file, "writing string <%s>\n", "skip"));

			D4(fprintf(debug_file, "writing string <%s>\n", "skip"));

			write(ofd, "skip", 4);

			write(ofd, "skip", 4);

			lseek(ofd, gap - 8, SEEK_CUR); //! lseek over the gap and proceed as before

			lseek(ofd, gap - 8, SEEK_CUR); // lseek over the gap and proceed as before

		}

		}

		if (sizes != NULL) {

		if (sizes != NULL) {

			l = 0;

			l = 0;

camogm_ogm.c

+1 −1
Original line number Original line Diff line number Diff line
@@ -178,7 +178,7 @@ int camogm_frame_ogm(camogm_state *state) 
 * @brief Finish OGM file operation

 * @brief Finish OGM file operation

 * @param[in]   state   a pointer to a structure containing current state

 * @param[in]   state   a pointer to a structure containing current state

 * @return      0 if file was saved successfully and negative error code otherwise

 * @return      0 if file was saved successfully and negative error code otherwise

 * @note: zero packets are OK, use them to end file with "last" turned on

 * @note Zero packets are OK, use them to end file with "last" turned on

 */

 */

int camogm_end_ogm(camogm_state *state)

int camogm_end_ogm(camogm_state *state)

{

{