From c6f5275accc9154a25fab9c48762527343cf9851 Mon Sep 17 00:00:00 2001 From: Justin Viiret Date: Wed, 12 Apr 2017 11:24:30 +1000 Subject: [PATCH] mcclellancompile: docs for main compile function --- src/nfa/mcclellancompile.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/nfa/mcclellancompile.h b/src/nfa/mcclellancompile.h index a176db28..baf72d9c 100644 --- a/src/nfa/mcclellancompile.h +++ b/src/nfa/mcclellancompile.h @@ -66,8 +66,20 @@ private: raw_dfa &rdfa; }; -/* accel_states: (optional) on success, is filled with the set of accelerable - * states */ +/** + * \brief Construct an implementation DFA. + * + * \param raw the raw dfa to construct from + * \param cc compile context + * \param rm report manger + * \param only_accel_init if true, only the init states will be examined for + * acceleration opportunities + * \param trust_daddy_states if true, trust the daddy state set in the raw dfa + * rather than conducting a search for a better daddy (for Sherman + * states) + * \param accel_states (optional) success, is filled with the set of + * accelerable states + */ bytecode_ptr mcclellanCompile(raw_dfa &raw, const CompileContext &cc, const ReportManager &rm, bool only_accel_init,