Skip to content

Commit

Permalink
media: atomisp: stop producing hundreds of kernel-doc warnings
Browse files Browse the repository at this point in the history
A recent change on Kernel 4.15-rc1 causes all tags with
/** to be handled as kernel-doc markups. Well, several
atomisp modules, it doesn't use kernel-doc, but some other
documentation markup (doxygen?).

So, suppress all those warns by:
	- replacing /**< by /**.
	- replacing /** by /*.

The core changes were done with:

	for i in $(find drivers/staging/media/atomisp -type f); do sed 's,/\*\* ,/\*, ' -i $i; done
	for i in $(find drivers/staging/media/atomisp -type f); do sed 's,/\*\*<,/\**,' -i $i; done
	for i in drivers/staging/media/atomisp/pci/atomisp2/css2400/runtime/debug/src/ia_css_debug.c drivers/staging/media/atomisp/pci/atomisp2/css2400/sh_css_sp.c drivers/staging/media/atomisp/pci/atomisp2/css2400/runtime/rmgr/src/rmgr_vbuf.c; do perl -ne 's,\/\*\*$,/*,g; print $_'  $i > a && mv a $i; done;

A few manual adjustments were made, where needed.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Acked-by: Sakari Ailus <[email protected]>
  • Loading branch information
mchehab committed Nov 30, 2017
1 parent 0422691 commit d929fb4
Show file tree
Hide file tree
Showing 160 changed files with 1,746 additions and 1,746 deletions.
34 changes: 17 additions & 17 deletions drivers/staging/media/atomisp/include/linux/atomisp.h
Original file line number Diff line number Diff line change
Expand Up @@ -208,25 +208,25 @@ struct atomisp_dis_vector {
};


/** DVS 2.0 Coefficient types. This structure contains 4 pointers to
/* DVS 2.0 Coefficient types. This structure contains 4 pointers to
* arrays that contain the coeffients for each type.
*/
struct atomisp_dvs2_coef_types {
short __user *odd_real; /**< real part of the odd coefficients*/
short __user *odd_imag; /**< imaginary part of the odd coefficients*/
short __user *even_real;/**< real part of the even coefficients*/
short __user *even_imag;/**< imaginary part of the even coefficients*/
short __user *odd_real; /** real part of the odd coefficients*/
short __user *odd_imag; /** imaginary part of the odd coefficients*/
short __user *even_real;/** real part of the even coefficients*/
short __user *even_imag;/** imaginary part of the even coefficients*/
};

/*
* DVS 2.0 Statistic types. This structure contains 4 pointers to
* arrays that contain the statistics for each type.
*/
struct atomisp_dvs2_stat_types {
int __user *odd_real; /**< real part of the odd statistics*/
int __user *odd_imag; /**< imaginary part of the odd statistics*/
int __user *even_real;/**< real part of the even statistics*/
int __user *even_imag;/**< imaginary part of the even statistics*/
int __user *odd_real; /** real part of the odd statistics*/
int __user *odd_imag; /** imaginary part of the odd statistics*/
int __user *even_real;/** real part of the even statistics*/
int __user *even_imag;/** imaginary part of the even statistics*/
};

struct atomisp_dis_coefficients {
Expand Down Expand Up @@ -390,16 +390,16 @@ struct atomisp_metadata_config {
* Generic resolution structure.
*/
struct atomisp_resolution {
uint32_t width; /**< Width */
uint32_t height; /**< Height */
uint32_t width; /** Width */
uint32_t height; /** Height */
};

/*
* This specifies the coordinates (x,y)
*/
struct atomisp_zoom_point {
int32_t x; /**< x coordinate */
int32_t y; /**< y coordinate */
int32_t x; /** x coordinate */
int32_t y; /** y coordinate */
};

/*
Expand All @@ -411,9 +411,9 @@ struct atomisp_zoom_region {
};

struct atomisp_dz_config {
uint32_t dx; /**< Horizontal zoom factor */
uint32_t dy; /**< Vertical zoom factor */
struct atomisp_zoom_region zoom_region; /**< region for zoom */
uint32_t dx; /** Horizontal zoom factor */
uint32_t dy; /** Vertical zoom factor */
struct atomisp_zoom_region zoom_region; /** region for zoom */
};

struct atomisp_parm {
Expand Down Expand Up @@ -758,7 +758,7 @@ enum atomisp_acc_arg_type {
ATOMISP_ACC_ARG_FRAME /* Frame argument */
};

/** ISP memories, isp2400 */
/* ISP memories, isp2400 */
enum atomisp_acc_memory {
ATOMISP_ACC_MEMORY_PMEM0 = 0,
ATOMISP_ACC_MEMORY_DMEM0,
Expand Down
2 changes: 1 addition & 1 deletion drivers/staging/media/atomisp/pci/atomisp2/atomisp_cmd.c
Original file line number Diff line number Diff line change
Expand Up @@ -5187,7 +5187,7 @@ int get_frame_info_nop(struct atomisp_sub_device *asd,
return 0;
}

/**
/*
* Resets CSS parameters that depend on input resolution.
*
* Update params like CSS RAW binning, 2ppc mode and pp_input
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4051,7 +4051,7 @@ int atomisp_css_get_formats_config(struct atomisp_sub_device *asd,
int atomisp_css_get_zoom_factor(struct atomisp_sub_device *asd,
unsigned int *zoom)
{
struct ia_css_dz_config dz_config; /**< Digital Zoom */
struct ia_css_dz_config dz_config; /** Digital Zoom */
struct ia_css_isp_config isp_config;
struct atomisp_device *isp = asd->isp;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ struct atomisp_histogram32 {
};

struct atomisp_dvs2_stat_types32 {
compat_uptr_t odd_real; /**< real part of the odd statistics*/
compat_uptr_t odd_imag; /**< imaginary part of the odd statistics*/
compat_uptr_t even_real;/**< real part of the even statistics*/
compat_uptr_t even_imag;/**< imaginary part of the even statistics*/
compat_uptr_t odd_real; /** real part of the odd statistics*/
compat_uptr_t odd_imag; /** imaginary part of the odd statistics*/
compat_uptr_t even_real;/** real part of the even statistics*/
compat_uptr_t even_imag;/** imaginary part of the even statistics*/
};

struct atomisp_dvs2_coef_types32 {
compat_uptr_t odd_real; /**< real part of the odd coefficients*/
compat_uptr_t odd_imag; /**< imaginary part of the odd coefficients*/
compat_uptr_t even_real;/**< real part of the even coefficients*/
compat_uptr_t even_imag;/**< imaginary part of the even coefficients*/
compat_uptr_t odd_real; /** real part of the odd coefficients*/
compat_uptr_t odd_imag; /** imaginary part of the odd coefficients*/
compat_uptr_t even_real;/** real part of the even coefficients*/
compat_uptr_t even_imag;/** imaginary part of the even coefficients*/
};

struct atomisp_dvs2_statistics32 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ struct atomisp_subdev_params {

bool dis_proj_data_valid;

struct ia_css_dz_config dz_config; /**< Digital Zoom */
struct ia_css_dz_config dz_config; /** Digital Zoom */
struct ia_css_capture_config capture_config;

struct atomisp_css_isp_config config;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* Forward declarations.
*
**********************************************************************/
/**
/*
* @brief Read the oldest element from the circular buffer.
* Read the oldest element WITHOUT checking whehter the
* circular buffer is empty or not. The oldest element is
Expand All @@ -34,7 +34,7 @@
static inline ia_css_circbuf_elem_t
ia_css_circbuf_read(ia_css_circbuf_t *cb);

/**
/*
* @brief Shift a chunk of elements in the circular buffer.
* A chunk of elements (i.e. the ones from the "start" position
* to the "chunk_src" position) are shifted in the circular buffer,
Expand All @@ -48,7 +48,7 @@ static inline void ia_css_circbuf_shift_chunk(ia_css_circbuf_t *cb,
uint32_t chunk_src,
uint32_t chunk_dest);

/**
/*
* @brief Get the "val" field in the element.
*
* @param elem The pointer to the element.
Expand All @@ -63,7 +63,7 @@ ia_css_circbuf_elem_get_val(ia_css_circbuf_elem_t *elem);
* Non-inline functions.
*
**********************************************************************/
/**
/*
* @brief Create the circular buffer.
* Refer to "ia_css_circbuf.h" for details.
*/
Expand All @@ -88,7 +88,7 @@ ia_css_circbuf_create(ia_css_circbuf_t *cb,
cb->elems = elems;
}

/**
/*
* @brief Destroy the circular buffer.
* Refer to "ia_css_circbuf.h" for details.
*/
Expand All @@ -99,7 +99,7 @@ void ia_css_circbuf_destroy(ia_css_circbuf_t *cb)
cb->elems = NULL;
}

/**
/*
* @brief Pop a value out of the circular buffer.
* Refer to "ia_css_circbuf.h" for details.
*/
Expand All @@ -116,7 +116,7 @@ uint32_t ia_css_circbuf_pop(ia_css_circbuf_t *cb)
return ret;
}

/**
/*
* @brief Extract a value out of the circular buffer.
* Refer to "ia_css_circbuf.h" for details.
*/
Expand Down Expand Up @@ -166,7 +166,7 @@ uint32_t ia_css_circbuf_extract(ia_css_circbuf_t *cb, int offset)
return val;
}

/**
/*
* @brief Peek an element from the circular buffer.
* Refer to "ia_css_circbuf.h" for details.
*/
Expand All @@ -180,7 +180,7 @@ uint32_t ia_css_circbuf_peek(ia_css_circbuf_t *cb, int offset)
return cb->elems[pos].val;
}

/**
/*
* @brief Get the value of an element from the circular buffer.
* Refer to "ia_css_circbuf.h" for details.
*/
Expand All @@ -194,7 +194,7 @@ uint32_t ia_css_circbuf_peek_from_start(ia_css_circbuf_t *cb, int offset)
return cb->elems[pos].val;
}

/** @brief increase size of a circular buffer.
/* @brief increase size of a circular buffer.
* Use 'CAUTION' before using this function. This was added to
* support / fix issue with increasing size for tagger only
* Please refer to "ia_css_circbuf.h" for details.
Expand Down Expand Up @@ -252,7 +252,7 @@ bool ia_css_circbuf_increase_size(
* Inline functions.
*
****************************************************************/
/**
/*
* @brief Get the "val" field in the element.
* Refer to "Forward declarations" for details.
*/
Expand All @@ -262,7 +262,7 @@ ia_css_circbuf_elem_get_val(ia_css_circbuf_elem_t *elem)
return elem->val;
}

/**
/*
* @brief Read the oldest element from the circular buffer.
* Refer to "Forward declarations" for details.
*/
Expand All @@ -282,7 +282,7 @@ ia_css_circbuf_read(ia_css_circbuf_t *cb)
return elem;
}

/**
/*
* @brief Shift a chunk of elements in the circular buffer.
* Refer to "Forward declarations" for details.
*/
Expand Down
Loading

0 comments on commit d929fb4

Please sign in to comment.