Merge pull request #1888 from fspindle/feat_doxygen_doc

Improve doxygen documentation

Author: fspindle

modules/core/include/visp3/core/vpImage_getters.h

@@ -766,6 +766,51 @@ void vpImage<Type>::getMinMaxLoc(vpImagePoint *minLoc, vpImagePoint *maxLoc, Typ
  * considered, if set to true.
  * \param[out] nbValidPoints Optional parameter. When different from nullptr contains the number of points that are
  * valid according to the boolean mask or image size when `p_mask` is set to nullptr.
+ *
+ * The following sample code shows how to use \b vpImage::getMeanValue():
+ * \code
+ * #include <visp3/core/vpImage.h>
+ *
+ * #ifdef ENABLE_VISP_NAMESPACE
+ * using namespace VISP_NAMESPACE_NAME;
+ * #endif
+ *
+ * int main()
+ * {
+ *   // gray
+ *   {
+ *     vpImage<unsigned char> I(1, 2);
+ *     I[0][0] = 1;
+ *     I[0][1] = 2;
+ *
+ *     std::cout << "Gray image mean value: " << I.getMeanValue() << std::endl;
+ *     std::cout << "Gray image global mean value: " << I.getMeanValue() << std::endl; // nchannels = 1
+ *   }
+ *   // color
+ *   {
+ *     vpImage<vpRGBa> I(1, 2);
+ *     I[0][0].R = 1;
+ *     I[0][0].G = 2;
+ *     I[0][0].B = 3;
+ *     I[0][1].R = 4;
+ *     I[0][1].G = 5;
+ *     I[0][1].B = 6;
+ *
+ *     int nchannels = 3;
+ *     std::cout << "RGBa color image mean value: " << I.getMeanValue() << std::endl;
+ *     std::cout << "RGBa color image global mean value: " << I.getMeanValue() / nchannels << std::endl;
+ *   }
+ *
+ *   return EXIT_SUCCESS;
+ * }
+ * \endcode
+ * It produces the following output:
+ * \code{.sh}
+ * Gray image mean value: 1.5
+ * Gray image global mean value: 1.5
+ * RGBa color image mean value: 10.5
+ * RGBa color image global mean value: 3.5
+ * \endcode
  */
 template <class Type> double vpImage<Type>::getMeanValue(const vpImage<bool> *p_mask, unsigned int *nbValidPoints) const
 {

modules/core/src/tools/file/vpIoTools_npy.cpp

@@ -429,7 +429,7 @@ visp::cnpy::NpyArray load_the_npz_array(FILE *fp, uint32_t compr_bytes, uint32_t
 
 // https://github.com/francescopace/cnpy/blob/4170b94634e5ff5b6925708f450480a9601627a9/cnpy.h#L187-L214
 void visp::cnpy::compressData(size_t nbytes_uncompressed, std::vector<uint8_t> &uncompressed,
-  std::vector<uint8_t> &buffer_compressed, size_t &nbytes_on_disk, FILE *fp)
+                              std::vector<uint8_t> &buffer_compressed, size_t &nbytes_on_disk, FILE *fp)
 {
   // Compress using zlib deflate (raw deflate, no zlib/gzip header)
   uLongf max_compressed_size = compressBound(nbytes_uncompressed);
@@ -817,13 +817,14 @@ std::vector<char> utf8_to_utf32_vec_pad(const std::string &utf8, const std::size
   \param[in] data_vec : Vector of std::string.
   \param[in] shape : Shape of the array, e.g. Nz x Ny x Nx.
   \param[in] mode : Writing mode, i.e. overwrite (w) or append (a) to the file.
+  \param[in] compress_data : If true, the data is compressed using the DEFLATE algorithm.
   \warning This function should also work on big-endian platform, without guarantee since it has not been tested extensively.
   \note Original library: <a href="https://github.com/rogersce/cnpy">cnpy</a> with MIT license.
 
   \sa To see how to use it, you may have a look at \ref tutorial-npz
  */
 void visp::cnpy::npz_save_str(const std::string &zipname, std::string fname, const std::vector<std::string> &data_vec,
-    const std::vector<size_t> &shape, const std::string &mode, bool compress_data)
+                              const std::vector<size_t> &shape, const std::string &mode, bool compress_data)
 {
   if (data_vec.empty()) {
     vpException(vpException::badValue, "Input string data is empty.");
@@ -1006,13 +1007,14 @@ void visp::cnpy::npz_save_str(const std::string &zipname, std::string fname, con
   \param[in] fname : Identifier for the corresponding array of data.
   \param[in] data_str : C++ std::string data.
   \param[in] mode : Writing mode, i.e. overwrite (w) or append (a) to the file.
+  \param[in] compress_data : If true, the data is compressed using the DEFLATE algorithm.
   \warning This function should also work on big-endian platform, without guarantee since it has not been tested extensively.
   \note Original library: <a href="https://github.com/rogersce/cnpy">cnpy</a> with MIT license.
 
   \sa To see how to use it, you may have a look at \ref tutorial-npz
  */
 void visp::cnpy::npz_save_str(const std::string &zipname, const std::string &fname, const std::string &data_str,
-  const std::string &mode, bool compress_data)
+                              const std::string &mode, bool compress_data)
 {
   std::vector<std::string> data_vec;
   data_vec.push_back(data_str);