class Horde_Support_Backtrace
{
/**
- * Backtrace
+ * Backtrace.
+ *
* @var array
*/
protected $_backtrace;
}
/**
- * Wrap the result of debug_backtrace(). By specifying a non-zero
- * $nestingLevel, levels of the backtrace can be ignored. For instance, when
- * Horde_Support_Backtrace creates a backtrace for you, it ignores the
- * Horde_Backtrace constructor in the wrapped trace.
+ * Wraps the result of debug_backtrace().
+ *
+ * By specifying a non-zero $nestingLevel, levels of the backtrace can be
+ * ignored. For instance, when Horde_Support_Backtrace creates a backtrace
+ * for you, it ignores the Horde_Backtrace constructor in the wrapped
+ * trace.
*
- * @param array $backtrace The debug_backtrace() result
- * @param integer $nestingLevel The number of levels of the backtrace to ignore.
+ * @param array $backtrace The debug_backtrace() result.
+ * @param integer $nestingLevel The number of levels of the backtrace to
+ * ignore.
*/
public function createFromDebugBacktrace($backtrace, $nestingLevel = 0)
{
}
/**
- * Wrap an Exception object's backtrace
+ * Wraps an Exception object's backtrace.
*
- * @param Exception $e The exception to wrap
+ * @param Exception $e The exception to wrap.
*/
public function createFromException(Exception $e)
{
}
/**
- * Return the nesting level (number of calls deep) of the current context.
+ * Returns the nesting level (number of calls deep) of the current context.
*
- * @return integer Nesting level
+ * @return integer Nesting level.
*/
public function getNestingLevel()
{
}
/**
- * Return the context at a specific nesting level.
+ * Returns the context at a specific nesting level.
*
* @param integer $nestingLevel 0 == current level, 1 == caller, and so on
*
- * @return array The requested context
+ * @return array The requested context.
*/
public function getContext($nestingLevel)
{
}
/**
- * Return details about the caller of the routine where the exception
- * occurred
+ * Returns details about the routine where the exception occurred.
*
* @return array $caller
*/
}
/**
- * Return details about the caller of the routine where the exception
- * occurred
+ * Returns details about the caller of the routine where the exception
+ * occurred.
*
* @return array $caller
*/