Adds notes in doxygen for which functions need v1.1.

diff --git a/src/aop-type.c b/src/aop-type.c
index b510d2c641b0fdedeada6fd5d2d3359dce0c12ad..ee5320c95f596c9c81c6537f8195fc4d7e293033 100644 (file)
--- a/src/aop-type.c
+++ b/src/aop-type.c
@@ -691,6 +691,8 @@ aop_t_pointer_to (const struct aop_type *type)
  * Check if an #aop_type object matches a pointer type.  This check is
  * true if and only if the specified type matches a subset of types
  * that aop_t_all_pointer() matches.
+ *
+ * (Since version 1.1)
  * \param type The type to check.
  * \return Non-zero if the #aop_type object matches a pointer type,
  * zero otherwise.
@@ -711,6 +713,8 @@ aop_is_pointer_type (const struct aop_type *type)
  * Only use this function on dynvals whose type passes
  * aop_is_pointer_type().  Casting a non-pointer type with this
  * function will raise a fatal compiler error.
+ *
+ * (Since version 1.1)
  * \param dv The #aop_dynval to cast.
  */
 void
@@ -726,6 +730,8 @@ aop_cast_to_all_pointer (struct aop_dynval *dv)
  * Get the type for an #aop_dynval object.  Every dynval has an
  * associated type that is determined by how it was matched and
  * captured.
+ *
+ * (Since version 1.1)
  * \return The type of the specified dynval.
  */
 const struct aop_type *aop_get_dynval_type (struct aop_dynval *dv)
@@ -736,6 +742,8 @@ const struct aop_type *aop_get_dynval_type (struct aop_dynval *dv)
 /**
  * Check if an #aop_type object matches one of the types that
  * aop_t_all_signed() matches.
+ *
+ * (Since version 1.1)
  * \param type The type to check.
  * \return Non-zero if the #aop_type object is standard-sized signed
  * integer type.
@@ -750,6 +758,8 @@ aop_is_all_signed_subtype (const struct aop_type *type)
 /**
  * Check if an #aop_type object matches one of the types that
  * aop_t_all_unsigned() matches.
+ *
+ * (Since version 1.1)
  * \param type The type to check.
  * \return Non-zero if the #aop_type object is standard-sized unsigned
  * integer type.
@@ -768,6 +778,8 @@ aop_is_all_unsigned_subtype (const struct aop_type *type)
  * Only use this function on dynvals whose type passes
  * aop_is_all_signed_subtype().  Casting any other type with this
  * function will raise a fatal compiler error.
+ *
+ * (Since version 1.1)
  * \param dv The #aop_dynval to cast.
  */
 void
@@ -787,6 +799,8 @@ aop_cast_to_all_signed(struct aop_dynval *dv)
  * Only use this function on dynvals whose type passes
  * aop_is_all_unsigned_subtype().  Casting any other type with this
  * function will raise a fatal compiler error.
+ *
+ * (Since version 1.1)
  * \param dv The #aop_dynval to cast.
  */
 void
@@ -801,6 +815,8 @@ aop_cast_to_all_unsigned(struct aop_dynval *dv)
 /**
  * Check if an #aop_type object matches one of the types that
  * aop_t_all_fp() matches.
+ *
+ * (Since version 1.1)
  * \param type The type to check.
  * \return Non-zero if the #aop_type object is standard-sized signed
  * floating point type.
@@ -819,7 +835,9 @@ aop_is_all_fp_subtype (const struct aop_type *type)
  * Only use this function on dynvals whose type passes
  * aop_is_all_fp_subtype().  Casting a non-float type with this
  * function will raise a fatal compiler error.
- * param dv The #aop_dynval to cast.
+ *
+ * (Since version 1.1)
+ * \param dv The #aop_dynval to cast.
  */
 void
 aop_cast_to_all_fp(struct aop_dynval *dv)

diff --git a/src/tracecut.c b/src/tracecut.c
index b7c9c2910d57912a9b8c660211eb9aa2e204d4eb..7461b0bef7f3e81c19f547304cf14051c1285702 100644 (file)
--- a/src/tracecut.c
+++ b/src/tracecut.c
@@ -133,6 +133,7 @@ struct tc_tracecut {
  * is defined as a weak symbol, so you can override it by defining
  * your own version.
  *
+ * Tracecuts are available starting with InterAspect version 1.1.
  * \{
  */
 
@@ -240,6 +241,7 @@ is_valid_identifier(const char *str)
  * Use tc_reset_error() to set a tracecut's error code back to
  * #TC_SUCCESS.
  *
+ * (Since version 1.1)
  * \param tc The tracecut to check.
  * \return The error code of the first failed operation on this
  * tracecut, or TC_SUCCESS if no operations failed.
@@ -254,6 +256,8 @@ tc_error_code (struct tc_tracecut *tc)
  * Clear the history of any failed operations on this tracecut.  After
  * calling this, tc_error_code() will return #TC_SUCCESS until some
  * later tracecut operation fails.
+ *
+ * (Since version 1.1)
  * \param tc The tracecut to reset.
  */
 void
@@ -285,6 +289,7 @@ check_param_type(const struct aop_type *type)
  * All params must have an #aop_type that matches pointer types only
  * (i.e., aop_is_pointer_type() returns true).
  *
+ * (Since version 1.1)
  * \param tc The tracecut to add a param to.
  * \param name The name used to reference this param.
  * \param type They type of this param.
@@ -367,6 +372,7 @@ lookup_call_symbol (struct tc_tracecut *tc, const char *name)
  * symbol will fail.  It is possible to create multiple symbols for
  * the same function.
  *
+ * (Since version 1.1)
  * \param tc The tracecut to add a symbol to.
  * \param name The name used to reference this symbol.
  * \param func_name The name of the function that should trigger the
@@ -464,6 +470,8 @@ add_call_symbol_binding (struct tc_tracecut *tc, const char *param_name,
  * Bind a tracecut param to a call symbol's <code>call_param</code>.
  * Binding to a <code>call_param</code> will capture that parameter at
  * runtime.
+ *
+ * (Since version 1.1)
  * \param tc The tracecut to add a binding to.
  * \param param_name Name of the tracecut param to bind.
  * \param symbol_name Name of the call symbol to bind to.
@@ -493,6 +501,8 @@ tc_bind_to_call_param (struct tc_tracecut *tc, const char *param_name,
 /**
  * Bind a tracecut param to a call symbol's return value.  Binding to
  * return value will capture that return value at runtime.
+ *
+ * (Since version 1.1)
  * \param tc The tracecut to add a binding to.
  * \param param_name Name of the tracecut param to bind.
  * \param symbol_name Name of the call symbol to bind to.
@@ -539,6 +549,7 @@ tc_bind_to_return_value (struct tc_tracecut *tc, const char *param_name,
  *
  * <code>"(param)func_name()"</code>
  *
+ * (Since version 1.1)
  * \param tc The tracecut to add the symbol to.
  * \param name The name used to reference this symbol.
  * \param declaration A string declaring the name of the function that
@@ -727,6 +738,8 @@ tc_declare_call_symbol (struct tc_tracecut *tc, const char *name,
  * symbols (expressed with <code>symbol_name</code> strings) combined
  * with the standard <code>|</code>, <code>*</code>, <code>+</code>,
  * and <code>?</code> operators and parenthesis for grouping.
+ *
+ * (Since version 1.1)
  * \param tc The tracecut to add the rule to.
  * \param specification A regular expression over the alphabet of the
  * tracecut's symbols.
@@ -766,6 +779,8 @@ tc_add_rule (struct tc_tracecut *tc, const char *specification)
  * Create an empty tc_tracecut object.  The caller is responsible for
  * freeing the object using tc_free_tracecut().  (Do not use the
  * standard free function.)
+ *
+ * (Since version 1.1)
  * \return A new tc_tracecut that must be freed with
  * tc_free_tracecut().  The return value will be NULL if allocation
  * fails or if compilation has already started..
@@ -891,6 +906,8 @@ free_rule_list (struct tc_tracecut *tc)
  * Free all the memory used by a tc_tracecut object.  Every call to
  * tc_create_tracecut() should have a matching call to
  * tc_free_tracecut().
+ *
+ * (Since version 1.1)
  * \param tc The tracecut object to free.
  */
 void
@@ -1102,6 +1119,7 @@ get_num_rules (struct tc_tracecut *tc)
  * initialization should go.  This join point should execute only
  * once, right when you want tracecut monitoring to start.
  *
+ * (Since version 1.1)
  * \param jp The join point to insert initialization at.
  */
 void
@@ -1211,6 +1229,7 @@ tracecut_pass (void)
  * work, you must either set a main function or manually add this
  * initiliazation code using tc_insert_tracecut_init_advice().
  *
+ * (Since version 1.1)
  * \param func_name The name of the main function.
  */
 void
@@ -1225,6 +1244,8 @@ tc_set_main_function (const char *func_name)
  * Call this from your aop_main() function to register a pass that
  * will add tracecut instrumentation.  A tracecut plug-in will not do
  * anything without this call!
+ *
+ * (Since version 1.1)
  */
 void
 tc_register_tracecut_pass (void)