Two new environments: datadescni and funcdescni. These are similar to

datadesc and funcdesc, but don't add entries to the index.
This commit is contained in:
Fred Drake 1998-02-13 14:34:04 +00:00
parent 00dcfb2bc3
commit aebc6f399e
1 changed files with 17 additions and 3 deletions

View File

@ -200,11 +200,15 @@
\let\endctypedesc\endfulllineitems \let\endctypedesc\endfulllineitems
% funcdesc should be called as an \begin{funcdesc} ... \end{funcdesc} % funcdesc should be called as an \begin{funcdesc} ... \end{funcdesc}
\newcommand{\funcline}[2]{\item[\code{\bfcode{#1}(\varvars{#2})}]\ttindex{#1}} \newcommand{\funcline}[2]{\funclineni{#1}{#2}\ttindex{#1}}
\newcommand{\funcdesc}[2]{\fulllineitems\funcline{#1}{#2}} \newcommand{\funcdesc}[2]{\fulllineitems\funcline{#1}{#2}}
\let\endfuncdesc\endfulllineitems \let\endfuncdesc\endfulllineitems
\newcommand{\optional}[1]{{\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}} \newcommand{\optional}[1]{{\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
% similar to {funcdesc}, but doesn't add to the index
\newcommand{\funclineni}[2]{\item[\code{\bfcode{#1}(\varvars{#2})}]}
\newcommand{\funcdescni}[2]{\fulllineitems\funclineni{#1}{#2}}
\let\endfuncdescni\endfulllineitems
% same for excdesc % same for excdesc
\newcommand{\excline}[1]{\item[\bfcode{#1}]\ttindex{#1}} \newcommand{\excline}[1]{\item[\bfcode{#1}]\ttindex{#1}}
@ -212,10 +216,15 @@
\let\endexcdesc\endfulllineitems \let\endexcdesc\endfulllineitems
% same for datadesc % same for datadesc
\newcommand{\dataline}[1]{\item[\bfcode{#1}]\ttindex{#1}} \newcommand{\dataline}[1]{\datalineni{#1}\ttindex{#1}}
\newcommand{\datadesc}[1]{\fulllineitems\dataline{#1}} \newcommand{\datadesc}[1]{\fulllineitems\dataline{#1}}
\let\enddatadesc\endfulllineitems \let\enddatadesc\endfulllineitems
% similar to {datadesc}, but doesn't add to the index
\newcommand{\datalineni}[1]{\item[\bfcode{#1}]}
\newcommand{\datadescni}[1]{\fulllineitems\datalineni{#1}}
\let\enddatadescni\endfulllineitems
% opcodedesc should be called as an \begin{opcodedesc} ... \end{opcodedesc} % opcodedesc should be called as an \begin{opcodedesc} ... \end{opcodedesc}
\newcommand{\opcodeline}[2]{\item[\bfcode{#1}\quad\var{#2}]} \newcommand{\opcodeline}[2]{\item[\bfcode{#1}\quad\var{#2}]}
@ -303,7 +312,12 @@
% \end{seealso} % \end{seealso}
\newenvironment{seealso}[0]{\strong{See Also:}\par}{\par} \newenvironment{seealso}[0]{\strong{See Also:}\par}{\par}
\newcommand{\seemodule}[2]{\ref{module-#1}: \module{#1}\quad(#2)} \newcommand{\seemodule}[2]{\ref{module-#1}:%
\quad Module \module{#1}\quad(#2)}
\newcommand{\seebimodule}[2]{\ref{module-#1}:%
\quad Built-in Module \module{#1}\quad(#2)}
\newcommand{\seestmodule}[2]{\ref{module-#1}:%
\quad Standard Module \module{#1}\quad(#2)}
\newcommand{\seetext}[1]{\par{#1}} \newcommand{\seetext}[1]{\par{#1}}
% Fix the theindex environment to add an entry to the Table of % Fix the theindex environment to add an entry to the Table of