Long descriptive name of my introduction
First sectionThis file is supposed to contain some introductory material about whole code included in your documentation. You can note that all rules that apply to normal pasdoc descriptions apply also here, e.g. empty line means new paragraph: New paragraph. 3rd paragraph. URLs are automatically recognized, like this: http://pasdoc.sourceforge.net/. You have to write the @ twice (like @@) to get one @ in the output. Also normal @-tags work: Second sectionHere you can see some hot snippet from implementation of this feature, just to test @longcode tag: procedure TPasDoc.HandleExtraFile(const FileName: string; out ExtraDescription: TExtraDescription); begin ExtraDescription := TExtraDescription.Create; try DoMessage(2, mtInformation, 'Now parsing file %s...', [FileName]); ExtraDescription.Name := SCharsReplace( ChangeFileExt( ExtractFileName(FileName) , ''), [' '], '_'); ExtraDescription.RawDescription := FileToString(FileName); except FreeAndNil(ExtraDescription); raise; end; end;
Third sectionNormal links work : MyConstant. Blah. Blah. Blah. Blah. Blah. Blah. Here is a paragraph with an anchor. It looks like a normal paragraph, but you can link to it with @link(SomeAnchor). Blah. Blah. Blah. Blah. Blah. Blah. Blah. Blah. Blah. Sections with the same user-visible names are OK (example when this is useful is below): Routines dealing with stringsOverviewExamplesRoutines dealing with integersOverviewExamplesAuthorCreatedOn some rainy day |