diff options
Diffstat (limited to 'doc/docgen.rst')
| -rw-r--r-- | doc/docgen.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/docgen.rst b/doc/docgen.rst index eb96992b8..9607089d8 100644 --- a/doc/docgen.rst +++ b/doc/docgen.rst @@ -295,8 +295,8 @@ The relationship of type to suffix is made by the proc ``complexName`` in the ``compiler/docgen.nim`` file. Here are some examples of complex names for symbols in the `system module <system.html>`_. -* ``type SignedInt = int | int8 | int16 | int32 | int64`` **=>** - `#SignedInt <system.html#SignedInt>`_ +* ``type SomeSignedInt = int | int8 | int16 | int32 | int64`` **=>** + `#SomeSignedInt <system.html#SomeSignedInt>`_ * ``var globalRaiseHook: proc (e: ref E_Base): bool {.nimcall.}`` **=>** `#globalRaiseHook <system.html#globalRaiseHook>`_ * ``const NimVersion = "0.0.0"`` **=>** @@ -307,22 +307,22 @@ symbols in the `system module <system.html>`_. `#len,seq[T] <system.html#len,seq[T]>`_ * ``iterator pairs[T](a: seq[T]): tuple[key: int, val: T] {.inline.}`` **=>** `#pairs.i,seq[T] <system.html#pairs.i,seq[T]>`_ -* ``template newException[](exceptn: type; message: string): expr`` **=>** - `#newException.t,type,string - <system.html#newException.t,type,string>`_ +* ``template newException[](exceptn: typedesc; message: string; parentException: ref Exception = nil): untyped`` **=>** + `#newException.t,typedesc,string,ref.Exception + <system.html#newException.t,typedesc,string,ref.Exception>`_ Index (idx) file format ======================= Files with the ``.idx`` extension are generated when you use the `Index -switch`_ along with commands to generate documentation from source or text +switch <#related-options-index-switch>`_ along with commands to generate documentation from source or text files. You can programatically generate indices with the `setIndexTerm() -<rstgen.html#setIndexTerm>`_ and `writeIndexFile() -<rstgen.html#writeIndexFile>`_ procs. The purpose of ``idx`` files is to hold +<rstgen.html#setIndexTerm,RstGenerator,string,string,string,string,string>`_ and `writeIndexFile() +<rstgen.html#writeIndexFile,RstGenerator,string>`_ procs. The purpose of ``idx`` files is to hold the interesting symbols and their HTML references so they can be later concatenated into a big index file with `mergeIndexes() -<rstgen.html#mergeIndexes>`_. This section documents the file format in +<rstgen.html#mergeIndexes,string>`_. This section documents the file format in detail. Index files are line oriented and tab separated (newline and tab characters @@ -368,7 +368,7 @@ final index, and TOC entries found in ``.nim`` files are discarded. Additional resources ==================== -`Nim Compiler User Guide <nimc.html#command-line-switches>`_ +`Nim Compiler User Guide <nimc.html#compiler-usage-command-line-switches>`_ `RST Quick Reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ |