未验证 提交 04d6afc9 编写于 作者: 张春乔 提交者: GitHub

[开源创新大赛 赛题6] rm , from \* @param(.*?), (#54116)

* rm , from \* @param(.*?),

* Apply suggestions from code review

* Apply suggestions from code review
上级 f2f9b0c2
...@@ -435,7 +435,7 @@ class PADDLE_API Tensor final { ...@@ -435,7 +435,7 @@ class PADDLE_API Tensor final {
* data type template argument * data type template argument
* *
* @tparam T * @tparam T
* @param target_place, the target place of which the tensor will copy to. * @param target_place The target place of which the tensor will copy to.
* @return Tensor * @return Tensor
*/ */
template <typename T> template <typename T>
...@@ -444,8 +444,8 @@ class PADDLE_API Tensor final { ...@@ -444,8 +444,8 @@ class PADDLE_API Tensor final {
/** /**
* @brief Transfer the current Tensor to the specified device and return. * @brief Transfer the current Tensor to the specified device and return.
* *
* @param place, The target place of which the tensor will copy to. * @param place The target place of which the tensor will copy to.
* @param blocking, Should we copy this in sync way. * @param blocking Should we copy this in sync way.
* @return Tensor * @return Tensor
*/ */
Tensor copy_to(const Place& place, bool blocking) const; Tensor copy_to(const Place& place, bool blocking) const;
...@@ -453,8 +453,8 @@ class PADDLE_API Tensor final { ...@@ -453,8 +453,8 @@ class PADDLE_API Tensor final {
/** /**
* @brief Transfer the source Tensor to current Tensor. * @brief Transfer the source Tensor to current Tensor.
* *
* @param src, the source Tensor to be copied. * @param src The source Tensor to be copied.
* @param blocking, Should we copy this in sync way. * @param blocking Should we copy this in sync way.
* @return void * @return void
*/ */
void copy_(const Tensor& src, const Place& target_place, bool blocking); void copy_(const Tensor& src, const Place& target_place, bool blocking);
...@@ -589,7 +589,7 @@ class PADDLE_API Tensor final { ...@@ -589,7 +589,7 @@ class PADDLE_API Tensor final {
/** /**
* @brief Convert DenseTensor or SparseCsrTensor to SparseCooTensor * @brief Convert DenseTensor or SparseCsrTensor to SparseCooTensor
* *
* @param sparse_dim, The number of sparse dimensions * @param sparse_dim The number of sparse dimensions
* @return Tensor * @return Tensor
*/ */
Tensor to_sparse_coo(const int64_t sparse_dim) const; Tensor to_sparse_coo(const int64_t sparse_dim) const;
......
...@@ -32,13 +32,13 @@ class RecordEvent { ...@@ -32,13 +32,13 @@ class RecordEvent {
public: public:
static bool IsEnabled(); static bool IsEnabled();
/** /**
* @param name: If your string argument has a longer lifetime (e.g.: string * @param name If your string argument has a longer lifetime (e.g.: string
* literal, static variables, etc) than the event, use 'const char* name'. * literal, static variables, etc) than the event, use 'const char* name'.
* Do your best to avoid using 'std::string' as the argument type. It will * Do your best to avoid using 'std::string' as the argument type. It will
* cause deep-copy to harm performance. * cause deep-copy to harm performance.
* @param type: Classification which is used to instruct the profiling * @param type Classification which is used to instruct the profiling
* data statistics. * data statistics.
* @param level: Used to filter events, works like glog VLOG(level). * @param level Used to filter events, works like glog VLOG(level).
* RecordEvent will works if HostTraceLevel >= level. * RecordEvent will works if HostTraceLevel >= level.
*/ */
explicit RecordEvent( explicit RecordEvent(
...@@ -48,11 +48,11 @@ class RecordEvent { ...@@ -48,11 +48,11 @@ class RecordEvent {
const EventRole role = EventRole::kOrdinary); const EventRole role = EventRole::kOrdinary);
/** /**
* @param name: It is the caller's reponsibility to manage the underlying * @param name It is the caller's reponsibility to manage the underlying
* storage. RecordEvent stores the pointer. * storage. RecordEvent stores the pointer.
* @param type: Classification which is used to instruct the profiling * @param type Classification which is used to instruct the profiling
* data statistics. * data statistics.
* @param level: Used to filter events, works like glog VLOG(level). * @param level Used to filter events, works like glog VLOG(level).
* RecordEvent will works if HostTraceLevel >= level. * RecordEvent will works if HostTraceLevel >= level.
*/ */
explicit RecordEvent( explicit RecordEvent(
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册