The {@id} inline tag is used only in package-level documentation. It is very simply designed to solve the problem of identifying sections for hyperlinking. For instance, in the DocBook Converter, id's are in the format package.packagename[.subpackagename].file[.sectionname], where file is either the classname, function/method name, or summary. Package-level docs are located in the packagename directory in summary.xml, so any subsections are package.packagename.summary.idname. In the other Converters, the id is not nearly as restrictive, but this inline tag allows for the potential of future converters that are equally exacting. Use <refsect1 id="{@id idname}"> in the package-level docs (packagename.pkg) to do this.
Prev | Home | Next |
inline {@link} | Up | inline {@inheritdoc} |
Tag Documentation written by Gregory Beaver <cellog@users.sourceforge.net>
Copyright © 2002, Gregory Beaver