From c2e3a111a0f936cb80fce93e21de070fe0fc35e7 Mon Sep 17 00:00:00 2001 From: Henrik Skov Midtiby Date: Mon, 30 Mar 2009 23:13:06 +0200 Subject: [PATCH] Some documentation for obeyDraftOption --- todonotes.dtx | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/todonotes.dtx b/todonotes.dtx index 544bebf..0fc62e8 100644 --- a/todonotes.dtx +++ b/todonotes.dtx @@ -222,6 +222,13 @@ % |\missingfigure|) are defined as macros with no effect, and thus % all inserted notes are removed. % +% \DescribeMacro{obeyDraftOption} +% When the option |obeyDraftOption| is given, the package checks +% if the option |draft| is given (this option is usually given to +% the documentclass). If the |draft| option is given, the +% functionality of the package is enabled and otherwise the effect +% of the package is disabled. +% % \DescribeMacro{danish, german, french} % \DescribeMacro{spanish, catalan, italian} % Use the danish or german translations of the text strings @@ -906,9 +913,12 @@ % \begin{macrocode} \ProcessOptionsX % \end{macrocode} - +% If the |obeyDraftOption| is given, check whether the |draft| +% option is given and enable or disable the functionality of this +% package. % \begin{macrocode} \if@todonotes@obeyDraftOption + \@todonotes@disabledfalse \if@todonotes@isDraft \@todonotes@disabledtrue \fi