#20 4 question....
Hi everyone!
So, I have 4 question:
1: How to create multiline description? If I use this:
{ @author(Jónás Gergő jonas.gergo@chello.hu)
@created(2004.06.01.)
@lastmod(2004.06.01.)
@abstract(temp)
line1
line2
line3}
or this:
{ @author(Jónás Gergő jonas.gergo@chello.hu)
@created(2004.06.01.)
@lastmod(2004.06.01.)
@abstract(temp)}
{line1}
{line2}
{line3}
description, then a pasdoc generate this HTML text:
temp
line1 line2
line3
temp
line1<BR>line2<BR>line3
2: How to use the @created, @author and @lastmod
tags in the procedures and
functions description?
If I use this:
{ Description
@param(param: input parameter)
@returns(output)
@author(Jónás Gergő jonas.gergo@chello.hu)
@created(2004.06.01.)
@lastmod(2004.06.01.)}
function func(param:string):String;
description, then a pasdoc add the HTML file is only
@param and @returns
tag... WHY??? And the more tags?
3: How to add the html output a local variables, and the
local variables
descriptions?
If I use this description to the main.pas:
function Tmainform.Encrypt(s: string): string; var
{ i temporary variables...}
i: integer;
then the pasdoc not added the local variables and local
variables
descriptions to the main.tmainform.html file in the
encrypt function
subsection...
4: If I use this unit:
unit Main;
interface
uses
Windows, Form, SysUtils, Variants, Classes, Controls,
Graphics;
type
TMainForm = class(TForm)
MainMenu1: TMainMenu;
Menu_Exit: TMenuItem;
private
public
end;
Var MainForm: TMainForm;
implementation
uses my_unit1, my_unit2;
{$R *.dfm}
..............
then the generated html file is:
uses
-Windows
-Messages
-SysUtils
-Variants
-Classes
-Controls
-Graphics
OK. But where is my units? (my_unit1, my_unit2)
Thx for answers, bye:
Jónás Gergő
Logged In: YES
user_id=987895
AD 1: pasdoc generates correct output here. Just like in
HTML or LaTeX, line break in description is equivalent to a
space character.
If you really want to make line break in output
documentation you can use @br tag that I just implemented
(see http://pasdoc.sipsolutions.net/BrTag ). Or insert empty
line into description, this will make new paragraph (see
http://pasdoc.sipsolutions.net/WritingDocumentation ).
AD 2: @created, @author and @lastmod currently have an
effect only for units and classes (and interfaces and
records) descriptions. This indeed should be corrected some day.
AD 3, AD 4: pasdoc parses only unit interface, not
implementation. Not only this simplifies parsing, but also
the whole idea of pasdoc is to generate a documentation for
a programmer using this unit, not implementing it. So
documentation for local variables and units used in
implementation section is not relevant here.
Summary: I treat this request as partially fixed. The only
remaining issue here is number 2: using @created, @author
and @lastmod for all items.
I'm changing priority to 3 : this should be fixed, but it's
not high priority because it doesn't seem useful for many
people and you can temporary workaround this by writing
normal description text, like
{ Description
Author of this function is Jns Gergő,
jonas.gergo@chello.hu.
Created on 2004.06.01.
Last modified 2004.06.01. }
function func(param:string):String;