diff libinterp/octave-value/ov-base.h @ 24624:ce2eb28e0a6d

doc: make all Doxygen comment blocks more consistent * Array.h, dim-vector.h, gzip.cc, octave-link.h, octave-qt-link.h, oct-parse.in.yy, oct-string.h, ov-base.h, ov.h, ovl.h, str-vec.h: Use uniform C++ block commenting style consistent with the rest of Octave. Don't use unnecessary @brief or @class markers. Use @-style commands instead of \-style.
author Mike Miller <mtmiller@octave.org>
date Fri, 19 Jan 2018 19:59:28 -0800
parents f5ad5d6f16fd
children 78aff6f14227
line wrap: on
line diff
--- a/libinterp/octave-value/ov-base.h	Fri Jan 19 15:09:42 2018 -0800
+++ b/libinterp/octave-value/ov-base.h	Fri Jan 19 19:59:28 2018 -0800
@@ -105,20 +105,19 @@
 inline bool btyp_isarray (builtin_type_t btyp)
 { return btyp <= btyp_char; }
 
-/*!
- * \brief Determine the resulting type for a possible mixed-type operation.
- *
- * Rules for the resulting type:
- *   - bool -> double
- *   - single + double -> single
- *   - real + complex -> complex
- *   - integer + real -> integer
- *   - uint + uint -> uint (the bigger one)
- *   - sint + sint -> sint (the bigger one)
- *
- * \return The resulting type or "unknown type", if the resulting type cannot
- *         be determined.
- */
+//! Determine the resulting type for a possible mixed-type operation.
+//!
+//! Rules for the resulting type:
+//!   - bool -> double
+//!   - single + double -> single
+//!   - real + complex -> complex
+//!   - integer + real -> integer
+//!   - uint + uint -> uint (the bigger one)
+//!   - sint + sint -> sint (the bigger one)
+//!
+//! @return The resulting type or "unknown type", if the resulting type cannot
+//!         be determined.
+
 extern OCTINTERP_API
 builtin_type_t btyp_mixed_numeric (builtin_type_t x, builtin_type_t y);