Loading doc/custcmd.doc +7 −7 Original line number Original line Diff line number Diff line Loading @@ -37,10 +37,10 @@ The simplest form of an alias is a simple substitution of the form ALIASES += sideeffect="\par Side Effects:\n" ALIASES += sideeffect="\par Side Effects:\n" \endverbatim \endverbatim will allow you to will allow you to put the command \\sideeffect (or \@sideeffect) in the documentation, which put the command `\sideeffect` (or `@sideeffect`) in the documentation, which will result in a user-defined paragraph with heading <b>Side Effects:</b>. will result in a user-defined paragraph with heading <b>Side Effects:</b>. Note that you can put \\n's in the value part of an alias to insert newlines. Note that you can put `\n`'s in the value part of an alias to insert newlines. Also note that you can redefine existing special commands if you wish. Also note that you can redefine existing special commands if you wish. Loading @@ -50,7 +50,7 @@ combination with aliases. \section custcmd_complex Aliases with arguments \section custcmd_complex Aliases with arguments Aliases can also have one or more arguments. In the alias definition you then need Aliases can also have one or more arguments. In the alias definition you then need to specify the number of arguments between curly braces. In the value part of the to specify the number of arguments between curly braces. In the value part of the definition you can place \\x markers, where 'x' represents the argument number starting definition you can place `\x` markers, where '`x`' represents the argument number starting with 1. with 1. Here is an example of an alias definition with a single argument: Here is an example of an alias definition with a single argument: Loading Loading @@ -85,11 +85,11 @@ inside the comment block and it will expand to where the command with a single argument would still work as shown before. where the command with a single argument would still work as shown before. Aliases can also be expressed in terms of other aliases, e.g. a new command Aliases can also be expressed in terms of other aliases, e.g. a new command \\reminder can be expressed as a \\xrefitem via an intermediate \\xreflist command `\reminder` can be expressed as a \ref cmdxrefitem "\\xrefitem" via an intermediate `\xreflist` command as follows: as follows: \verbatim \verbatim ALIASES += xreflist{3}="\xrefitem \1 \"\2\" \"\3\" " \ ALIASES += xreflist{3}="\xrefitem \1 \"\2\" \"\3\" " ALIASES += reminder="\xreflist{reminders,Reminder,Reminders}" \ ALIASES += reminder="\xreflist{reminders,Reminder,Reminders}" \endverbatim \endverbatim Note that if for aliases with more than one argument a comma is used as a separator, Note that if for aliases with more than one argument a comma is used as a separator, Loading @@ -98,7 +98,7 @@ i.e. \verbatim \verbatim \l{SomeClass,Some text\, with an escaped comma} \l{SomeClass,Some text\, with an escaped comma} \endverbatim \endverbatim given the alias definition of \\l in the example above. given the alias definition of `\l` in the example above. \section custcmd_nesting Nesting custom command \section custcmd_nesting Nesting custom command Loading Loading
doc/custcmd.doc +7 −7 Original line number Original line Diff line number Diff line Loading @@ -37,10 +37,10 @@ The simplest form of an alias is a simple substitution of the form ALIASES += sideeffect="\par Side Effects:\n" ALIASES += sideeffect="\par Side Effects:\n" \endverbatim \endverbatim will allow you to will allow you to put the command \\sideeffect (or \@sideeffect) in the documentation, which put the command `\sideeffect` (or `@sideeffect`) in the documentation, which will result in a user-defined paragraph with heading <b>Side Effects:</b>. will result in a user-defined paragraph with heading <b>Side Effects:</b>. Note that you can put \\n's in the value part of an alias to insert newlines. Note that you can put `\n`'s in the value part of an alias to insert newlines. Also note that you can redefine existing special commands if you wish. Also note that you can redefine existing special commands if you wish. Loading @@ -50,7 +50,7 @@ combination with aliases. \section custcmd_complex Aliases with arguments \section custcmd_complex Aliases with arguments Aliases can also have one or more arguments. In the alias definition you then need Aliases can also have one or more arguments. In the alias definition you then need to specify the number of arguments between curly braces. In the value part of the to specify the number of arguments between curly braces. In the value part of the definition you can place \\x markers, where 'x' represents the argument number starting definition you can place `\x` markers, where '`x`' represents the argument number starting with 1. with 1. Here is an example of an alias definition with a single argument: Here is an example of an alias definition with a single argument: Loading Loading @@ -85,11 +85,11 @@ inside the comment block and it will expand to where the command with a single argument would still work as shown before. where the command with a single argument would still work as shown before. Aliases can also be expressed in terms of other aliases, e.g. a new command Aliases can also be expressed in terms of other aliases, e.g. a new command \\reminder can be expressed as a \\xrefitem via an intermediate \\xreflist command `\reminder` can be expressed as a \ref cmdxrefitem "\\xrefitem" via an intermediate `\xreflist` command as follows: as follows: \verbatim \verbatim ALIASES += xreflist{3}="\xrefitem \1 \"\2\" \"\3\" " \ ALIASES += xreflist{3}="\xrefitem \1 \"\2\" \"\3\" " ALIASES += reminder="\xreflist{reminders,Reminder,Reminders}" \ ALIASES += reminder="\xreflist{reminders,Reminder,Reminders}" \endverbatim \endverbatim Note that if for aliases with more than one argument a comma is used as a separator, Note that if for aliases with more than one argument a comma is used as a separator, Loading @@ -98,7 +98,7 @@ i.e. \verbatim \verbatim \l{SomeClass,Some text\, with an escaped comma} \l{SomeClass,Some text\, with an escaped comma} \endverbatim \endverbatim given the alias definition of \\l in the example above. given the alias definition of `\l` in the example above. \section custcmd_nesting Nesting custom command \section custcmd_nesting Nesting custom command Loading