Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
plusvic committed Sep 18, 2014
1 parent 55ee00d commit 5ae1a05
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/capi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,9 @@ Functions
.. c:function:: yr_string_matches_foreach(string, match)
Example:
Iterate over the :c:type:`YR_MATCH` structures associated to a given string
running the block of code that follows each time with a different value for
*match*. Example:

.. code-block:: c
Expand All @@ -450,6 +452,23 @@ Functions
..do something with match
}
.. c:function:: yr_rules_foreach(rules, rule)
Iterate over each :c:type:`YR_RULE` in a :c:type:`YR_RULES` object running
the block of code that follows each time with a different value for
*rule*. Example:

.. code-block:: c
YR_RULE* rule;
/* rules is a YR_RULES object */
yr_rules_foreach(rules, rule)
{
..do something with rule
}
Error codes
-----------

Expand Down

0 comments on commit 5ae1a05

Please sign in to comment.