Menu
▾
▴
[OMPT-svn-commit] OpenMPT r21896 - in trunk/OpenMPT/libopenmpt: . bindings/freebasic
|
From: <sv...@op...> - 2024-10-20 14:29:59
|
Author: sagamusix Date: Sun Oct 20 16:29:47 2024 New Revision: 21896 URL: https://source.openmpt.org/browse/openmpt/?op=revision&rev=21896 Log: [Doc] libopenmpt: Fix function documentation. Modified: trunk/OpenMPT/libopenmpt/bindings/freebasic/libopenmpt.bi trunk/OpenMPT/libopenmpt/libopenmpt.h trunk/OpenMPT/libopenmpt/libopenmpt.hpp Modified: trunk/OpenMPT/libopenmpt/bindings/freebasic/libopenmpt.bi ============================================================================== --- trunk/OpenMPT/libopenmpt/bindings/freebasic/libopenmpt.bi Sun Oct 20 15:09:07 2024 (r21895) +++ trunk/OpenMPT/libopenmpt/bindings/freebasic/libopenmpt.bi Sun Oct 20 16:29:47 2024 (r21896) @@ -1306,7 +1306,7 @@ /'* \brief Check if specified order is a skip ("+++") item - \param The order item to check. + \param order The order index to check. \return Returns non-zero value if the pattern index at the given order position represents a skip item. During playback, this item is ignored and playback resumes at the next order list item. \sa openmpt_module_is_order_stop_entry, openmpt_module_is_pattern_skip_item \since 0.8.0 @@ -1314,7 +1314,7 @@ Declare Function openmpt_module_is_order_skip_entry(ByVal module As openmpt_module Ptr, ByVal order As Long) As Long /'* \brief Check if specified pattern index is a skip ("+++") item - \param The pattern index to check. + \param pattern The pattern index to check. \return Returns non-zero value if the pattern index represents a skip item. During playback, this item is ignored and playback resumes at the next order list item. \sa openmpt_module_is_pattern_stop_item, openmpt_module_is_order_skip_entry, openmpt_module_get_order_pattern \since 0.8.0 @@ -1322,7 +1322,7 @@ Declare Function openmpt_module_is_pattern_skip_item(ByVal module As openmpt_module Ptr, ByVal pattern As Long) As Long /'* \brief Check if specified order is a stop ("---") item - \param The order item to check. + \param order The order index to check. \return Returns non-zero value if the pattern index at the given order position represents a stop item. When this item is reached, playback continues at the restart position of the current sub-song. \sa openmpt_module_is_order_skip_entry, openmpt_module_is_pattern_stop_item \since 0.8.0 @@ -1330,7 +1330,7 @@ Declare Function openmpt_module_is_order_stop_entry(ByVal module As openmpt_module Ptr, ByVal order As Long) As Long /'* \brief Check if specified pattern index is a stop ("---") item - \param The pattern index to check. + \param pattern The pattern index to check. \return Returns non-zero value if the pattern index represents a stop item. When this item is reached, playback continues at the restart position of the current sub-song. \sa openmpt_module_is_pattern_skip_item, openmpt_module_is_order_stop_entry, openmpt_module_get_order_pattern \since 0.8.0 Modified: trunk/OpenMPT/libopenmpt/libopenmpt.h ============================================================================== --- trunk/OpenMPT/libopenmpt/libopenmpt.h Sun Oct 20 15:09:07 2024 (r21895) +++ trunk/OpenMPT/libopenmpt/libopenmpt.h Sun Oct 20 16:29:47 2024 (r21896) @@ -1364,7 +1364,8 @@ /*! \brief Check if specified order is a skip ("+++") item * - * \param The order item to check. + * \param mod The module handle to work on. + * \param order The order index to check. * \return Returns non-zero value if the pattern index at the given order position represents a skip item. During playback, this item is ignored and playback resumes at the next order list item. * \sa openmpt_module_is_order_stop_entry, openmpt_module_is_pattern_skip_item * \since 0.8.0 @@ -1372,7 +1373,8 @@ LIBOPENMPT_API int openmpt_module_is_order_skip_entry( openmpt_module * mod, int32_t order ); /*! \brief Check if specified pattern index is a skip ("+++") item * - * \param The pattern index to check. + * \param mod The module handle to work on. + * \param pattern The pattern index to check. * \return Returns non-zero value if the pattern index represents a skip item. During playback, this item is ignored and playback resumes at the next order list item. * \sa openmpt_module_is_pattern_stop_item, openmpt_module_is_order_skip_entry, openmpt_module_get_order_pattern * \since 0.8.0 @@ -1380,7 +1382,8 @@ LIBOPENMPT_API int openmpt_module_is_pattern_skip_item( openmpt_module * mod, int32_t pattern ); /*! \brief Check if specified order is a stop ("---") item * - * \param The order item to check. + * \param mod The module handle to work on. + * \param order The order index to check. * \return Returns non-zero value if the pattern index at the given order position represents a stop item. When this item is reached, playback continues at the restart position of the current sub-song. * \sa openmpt_module_is_order_skip_entry, openmpt_module_is_pattern_stop_item * \since 0.8.0 @@ -1388,7 +1391,8 @@ LIBOPENMPT_API int openmpt_module_is_order_stop_entry( openmpt_module * mod, int32_t order ); /*! \brief Check if specified pattern index is a stop ("---") item * - * \param The pattern index to check. + * \param mod The module handle to work on. + * \param pattern The pattern index to check. * \return Returns non-zero value if the pattern index represents a stop item. When this item is reached, playback continues at the restart position of the current sub-song. * \sa openmpt_module_is_pattern_skip_item, openmpt_module_is_order_stop_entry, openmpt_module_get_order_pattern * \since 0.8.0 Modified: trunk/OpenMPT/libopenmpt/libopenmpt.hpp ============================================================================== --- trunk/OpenMPT/libopenmpt/libopenmpt.hpp Sun Oct 20 15:09:07 2024 (r21895) +++ trunk/OpenMPT/libopenmpt/libopenmpt.hpp Sun Oct 20 16:29:47 2024 (r21896) @@ -1021,7 +1021,7 @@ //! Check if specified order is a skip ("+++") item /*! - \param The order item to check. + \param order The order index to check. \return Returns true if the pattern index at the given order position represents a skip item. During playback, this item is ignored and playback resumes at the next order list item. \sa openmpt::module::is_order_stop_entry, openmpt::module::is_pattern_skip_item \since 0.8.0 @@ -1029,7 +1029,7 @@ LIBOPENMPT_CXX_API_MEMBER bool is_order_skip_entry( std::int32_t order ) const ; //! Check if specified pattern index is a skip ("+++") item /*! - \param The pattern index to check. + \param pattern The pattern index to check. \return Returns true if the pattern index represents a skip item. During playback, this item is ignored and playback resumes at the next order list item. \sa openmpt::module::is_pattern_stop_item, openmpt::module::is_order_skip_entry, openmpt::module::get_order_pattern \since 0.8.0 @@ -1037,7 +1037,7 @@ LIBOPENMPT_CXX_API_MEMBER bool is_pattern_skip_item( std::int32_t pattern ) const; //! Check if specified order is a stop ("---") item /*! - \param The order item to check. + \param order The order index to check. \return Returns true if the pattern index at the given order position represents a stop item. When this item is reached, playback continues at the restart position of the current sub-song. \sa openmpt::module::is_order_skip_entry, openmpt::module::is_pattern_stop_item \since 0.8.0 @@ -1045,7 +1045,7 @@ LIBOPENMPT_CXX_API_MEMBER bool is_order_stop_entry( std::int32_t order ) const; //! Check if specified pattern index is a stop ("---") item /*! - \param The pattern index to check. + \param pattern The pattern index to check. \return Returns true if the pattern index represents a stop item. When this item is reached, playback continues at the restart position of the current sub-song. \sa openmpt::module::is_pattern_skip_item, openmpt::module::is_order_stop_entry, openmpt::module::get_order_pattern \since 0.8.0 |
