pasdoc-main

Re: [Pasdoc-main] What the best way to specify examples?

[silvioprog <sil...@gm...>]

On Thu, Sep 15, 2016 at 1:09 AM, Michalis Kamburelis <
mic...@gm...> wrote:

> > The hr sounds good, I'm going to do it ASAP. :-)
>
> Cool:)
>
> You're welcome to update the documentation yourself then, too -- you
> can register on the wiki http://pasdoc.sipsolutions.net/ and I can add
> you to "trusted contributos" (so that you will not be asked for
> captcha at each edit).



I've tried to create my account there, but got "500 - Internal Server
Error". :-(

So, after looking some new generated docs using @includeCode, it seems the
best way is keep it as is, however, I can implement a small change to
recognize something like this:

@includeCode(
  demo1.dpr
  --
  demo2.dpr
)

the "--" is replaced by hr (*). More examples:

@includeCode(
  smallsample1.dpr
  smallsample2.dpr
  --
  longsample1.dpr
  --
  smallsample3.dpr
  smallsample4.dpr
)

(*) if it was implemented, we need to add a command-line parameter like
"--include-code-separator", so the user chose his own separator.

--
Silvio Clécio

Re: [Pasdoc-main] Extra unnecessary white-spaces

[silvioprog <sil...@gm...>]

On Thu, Sep 15, 2016 at 2:52 AM, silvioprog <sil...@gm...> wrote:
[...]

> I'm going to send a patch soon ... :-)
>

Done.

Can you check if it's OK before I send it as pull request? :-)

Thank you!

-- 
Silvio Clécio

Re: [Pasdoc-main] Extra unnecessary white-spaces

[silvioprog <sil...@gm...>]

On Thu, Sep 15, 2016 at 2:47 AM, silvioprog <sil...@gm...> wrote:
[...]

>         // Trim all early white-spaces
>         // Then indents the code with only two white-spaces
>

Oops,

// Trim all first white-spaces
// Then indent the code properly

^^'

I'm going to send a patch soon ... :-)

--
Silvio Clécio

Re: [Pasdoc-main] Extra unnecessary white-spaces

[silvioprog <sil...@gm...>]

On Thu, Sep 15, 2016 at 2:18 AM, Michalis Kamburelis <
mic...@gm...> wrote:

> 2016-09-15 6:55 GMT+02:00 silvioprog <sil...@gm...>:
> > So, what do you think about removing all first white-spaces? See a
> preview showing how it would be:
> >
>
> I *extremely* agree:) It's been bothering me since some time too, but
> I did not have time to deal with it.
>
> We should simply scan the lines of the @longCode, looking for the
> longest prefix composed of whitespace (spaces, tabs). And then (if
> this prefix is not empty) remove it (from all the lines).
>
> If you want to implement it, go very much ahead:)


I did a draft, but I need to test it ASAP:

procedure TDocGenerator.HandleLongCodeTag(
  ThisTag: TTag; var ThisTagData: TObject;
  EnclosingTag: TTag; var EnclosingTagData: TObject;
  const TagParameter: string; var ReplaceStr: string);
var
  Source: TStrings;
  Code, Line: string;
  I, FirstPos: Integer;
begin
  if TagParameter = '' then
    exit;
  // Trim off "marker" characters at the beginning and end of TagParameter.
  Code := Copy(TagParameter, 2, Length(TagParameter) - 2);
  FirstPos := FirstWordPos(Code);
  if FirstPos > 0 then
  begin
    Source := TStringList.Create;
    try
      Source.Text := Code;
      for I := 0 to Pred(Source.Count) do
      begin
        Line := Source[I];
        // Trim all early white-spaces
        // Then indents the code with only two white-spaces
        Source[I] := Copy(Line, FirstPos, MaxInt);
      end;
      Code := TrimRight(Source.Text);
    finally Source.Free; end;
  end;
  // Then format pascal code.
  ReplaceStr := FormatPascalCode(Code);
end;

-- 
Silvio Clécio

Re: [Pasdoc-main] Extra unnecessary white-spaces

[Michalis K. <mic...@gm...>]

2016-09-15 6:55 GMT+02:00 silvioprog <sil...@gm...>:
> So, what do you think about removing all first white-spaces? See a preview showing how it would be:
>

I *extremely* agree:) It's been bothering me since some time too, but
I did not have time to deal with it.

We should simply scan the lines of the @longCode, looking for the
longest prefix composed of whitespace (spaces, tabs). And then (if
this prefix is not empty) remove it (from all the lines).

If you want to implement it, go very much ahead:)

Regards,
Michalis

[Pasdoc-main] Extra unnecessary white-spaces

[silvioprog <sil...@gm...>]

Hello,

I've declared some codes using the @longCode tag, however I've noticed it
add extra first unnecessary white-spaces.

See the indented code below:

  TObjectHelper = class helper for TObject
  public
    { Returns the qualified name of the class.

      Example:

      @longCode(
        program Test;
        begin
          Writeln(TObject.QualifiedClassName); // displays System.TObject
        end.
      )

      @returns(The qualified name of the class)
    }
    class function QualifiedClassName: string;
  end;

it generates the following result:

[image: Inline image 1]

noticed the original indentation was broke, because it declared about 7
extra spaces:

.......program Test;
....... begin
.......   Writeln(TObject.QualifiedClassName); // displays System.TObject
....... end.

it should be:

program Test;
begin
..Writeln(TObject.QualifiedClassName); // displays System.TObject
end.

and I found a workaround in the PasDoc's source code to solve it:

https://github.com/michaliskambi/pasdoc/blob/master/source/component/PasDoc_GenHtml.pas#L121

but it sounds a little bit ugly, e.g:

  TObjectHelper = class helper for TObject
  public
    { Returns the qualified name of the class.

      Example:

@longCode(
  program Test;
  begin
    Writeln(TObject.QualifiedClassName); // displays System.TObject
  end.
)

      @returns(The qualified name of the class)
    }
    class function QualifiedClassName: string;
  end;

because I don't have any declaration starting too left of my source editor
except reserved words like program, unit, implementation and so on. :-)

So, what do you think about removing all first white-spaces? See a preview
showing how it would be:

[image: Inline image 2]

--
Silvio Clécio

Re: [Pasdoc-main] What the best way to specify examples?

[Michalis K. <mic...@gm...>]

> The hr sounds good, I'm going to do it ASAP. :-)

Cool:)

You're welcome to update the documentation yourself then, too -- you
can register on the wiki http://pasdoc.sipsolutions.net/ and I can add
you to "trusted contributos" (so that you will not be asked for
captcha at each edit).

Regards,
Michalis

Re: [Pasdoc-main] What the best way to specify examples?

[silvioprog <sil...@gm...>]

On Thu, Sep 15, 2016 at 12:08 AM, Michalis Kamburelis <
mic...@gm...> wrote:

>  2016-09-15 4:13 GMT+02:00 silvioprog <sil...@gm...>:
> >
> > Done: https://github.com/michaliskambi/pasdoc/pull/2 .
> >
> > Thank you very much!
> >
>
> Thank you for contributing -- perfect, applied!
>

:-)


> I added a simple documentation to
> http://pasdoc.sipsolutions.net/IncludeCodeTag .
>

I took a look at the new documentation, it was clear and understandable. :-)

ASAP we going to do a small update from:

"You can include multiple source code files (place each filename on a
separate line), they will simply be glued together. ... "

to:

"You can include multiple source code files (place each filename on a
separate line), they will simply be glued together separated by horizontal
lines. ... "


> Adding the sLineBreak (and later removing the last sLineBreak) is not
> necessary, so I removed it in a later commit. That is because you are
> "outside" the FormatPascalCode contents, so you're only adding a
> newline to the generated HTML, LaTeX, XML or such. In case of HTML, it
> will be simply ignored. Two files specified for the @includeCode will
> give this HTML output:
>
> --------
> <pre class="longcode"><span class="pascal_keyword">begin</span>
>   Writeln(<span class="pascal_string">'aaa'</span>);
> <span class="pascal_keyword">end</span>.
> </pre>
>
> <p></p>
>
> <pre class="longcode"><span class="pascal_keyword">begin</span>
>   Writeln(<span class="pascal_string">'aaa'</span>);
> <span class="pascal_keyword">end</span>.
> </pre>
> --------
>

Indeed.


> Your sLineBreak was only adding a newline inside the <p></p>, so it
> does not affect the actual look of the document:) To reliably add a
> newline in PasDoc_Gen, you should use a virtual function like
> LineBreak that makes correct output depending on generator ('<br>' in
> HTML and so on). Although in this case, the default paragraph
> separator works Ok.
>
> If needed, you could introduce a virtual function like
> HorizontalSeparator to TDocGenerator, and override it in HTML to
> return '<hr>', and then use it in HandleIncludeCodeTag to visually
> separate the examples by a horizontal line. I'm note sure what looks
> best here, I leave this decision up to you:)


The hr sounds good, I'm going to do it ASAP. :-)

-- 
Silvio Clécio

Re: [Pasdoc-main] What the best way to specify examples?

[Michalis K. <mic...@gm...>]

 2016-09-15 4:13 GMT+02:00 silvioprog <sil...@gm...>:
>
> Done: https://github.com/michaliskambi/pasdoc/pull/2 .
>
> Thank you very much!
>

Thank you for contributing -- perfect, applied!

I added a simple documentation to
http://pasdoc.sipsolutions.net/IncludeCodeTag .

Adding the sLineBreak (and later removing the last sLineBreak) is not
necessary, so I removed it in a later commit. That is because you are
"outside" the FormatPascalCode contents, so you're only adding a
newline to the generated HTML, LaTeX, XML or such. In case of HTML, it
will be simply ignored. Two files specified for the @includeCode will
give this HTML output:

--------
<pre class="longcode"><span class="pascal_keyword">begin</span>
  Writeln(<span class="pascal_string">'aaa'</span>);
<span class="pascal_keyword">end</span>.
</pre>

<p></p>

<pre class="longcode"><span class="pascal_keyword">begin</span>
  Writeln(<span class="pascal_string">'aaa'</span>);
<span class="pascal_keyword">end</span>.
</pre>
--------

Your sLineBreak was only adding a newline inside the <p></p>, so it
does not affect the actual look of the document:) To reliably add a
newline in PasDoc_Gen, you should use a virtual function like
LineBreak that makes correct output depending on generator ('<br>' in
HTML and so on). Although in this case, the default paragraph
separator works Ok.

If needed, you could introduce a virtual function like
HorizontalSeparator to TDocGenerator, and override it in HTML to
return '<hr>', and then use it in HandleIncludeCodeTag to visually
separate the examples by a horizontal line. I'm note sure what looks
best here, I leave this decision up to you:)

Regards,
Michalis

Re: [Pasdoc-main] What the best way to specify examples?

[silvioprog <sil...@gm...>]

On Wed, Sep 14, 2016 at 10:36 PM, Michalis Kamburelis <
mic...@gm...> wrote:

> 2016-09-15 2:42 GMT+02:00 silvioprog <sil...@gm...>:
> > On Wed, Sep 14, 2016 at 8:26 PM, silvioprog <silvioprog...> wrote:
> > [...]
> >
> > New patch in attachment.
> >
> > It allows multiple params in the @includeCode, e.g.:
> >
> >   @includeCode(
> >     demo1.dpr
> >     demo2.dpr
> >   )
> >
>
> Fantastic! Yes, please create a pull request to
> https://github.com/michaliskambi/pasdoc , this way I can apply it and
> it will be attributed to you nicely:)
>
> Briefly looking at the patches --- looks perfect:) I'll do some tests
> and apply it happily:)


Awesome! :-)

Done: https://github.com/michaliskambi/pasdoc/pull/2 .

Thank you very much!

-- 
Silvio Clécio

Re: [Pasdoc-main] Does PasDoc support "class helper"?

[Michalis K. <mic...@gm...>]

Indeed, it is supported:)
Michalis

2016-09-15 2:50 GMT+02:00 silvioprog <sil...@gm...>:
> Oops, please ignore this message, I've just added the conditionals param and
> now it works like a charm! ^^'
>
> On Wed, Sep 14, 2016 at 8:51 PM, silvioprog <sil...@gm...> wrote:
>>
>> Hello,
>>
>> Both Delphi and Free Pascal compileres offers the "class helper" support,
>> eg:
>>
>> {$IFDEF FPC}
>>   TObjectHelper = class helper for TObject
>>   public
>>     { Returns the qualified name of the class. Example:
>> @includeCode(../Doc/Parts/TObjectHelper.QualifiedClassName)
>> {$ENDIF}
>>
>> Does PasDoc support this feature?
>
>
> --
> Silvio Clécio
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Pasdoc-main mailing list
> Pas...@li...
> https://lists.sourceforge.net/lists/listinfo/pasdoc-main
>

Re: [Pasdoc-main] What the best way to specify examples?

[Michalis K. <mic...@gm...>]

2016-09-15 2:42 GMT+02:00 silvioprog <sil...@gm...>:
> On Wed, Sep 14, 2016 at 8:26 PM, silvioprog <silvioprog...> wrote:
> [...]
>
> New patch in attachment.
>
> It allows multiple params in the @includeCode, e.g.:
>
>   @includeCode(
>     demo1.dpr
>     demo2.dpr
>   )
>

Fantastic! Yes, please create a pull request to
https://github.com/michaliskambi/pasdoc , this way I can apply it and
it will be attributed to you nicely:)

Briefly looking at the patches --- looks perfect:) I'll do some tests
and apply it happily:)

Regards,
Michalis

Re: [Pasdoc-main] Does PasDoc support "class helper"?

[silvioprog <sil...@gm...>]

Oops, please ignore this message, I've just added the conditionals param
and now it works like a charm! ^^'

On Wed, Sep 14, 2016 at 8:51 PM, silvioprog <sil...@gm...> wrote:

> Hello,
>
> Both Delphi and Free Pascal compileres offers the "class helper" support,
> eg:
>
> {$IFDEF FPC}
>   TObjectHelper = class helper for TObject
>   public
>     { Returns the qualified name of the class. Example:
> @includeCode(../Doc/Parts/TObjectHelper.QualifiedClassName)
> {$ENDIF}
>
> Does PasDoc support this feature?
>

-- 
Silvio Clécio

Re: [Pasdoc-main] What the best way to specify examples?

[silvioprog <sil...@gm...>]

On Wed, Sep 14, 2016 at 8:26 PM, silvioprog <silvioprog...> wrote:
[...]

New patch in attachment.

It allows multiple params in the @includeCode, e.g.:

  @includeCode(
    demo1.dpr
    demo2.dpr
  )

-- 
Silvio Clécio

[Pasdoc-main] Does PasDoc support "class helper"?

[silvioprog <sil...@gm...>]

Hello,

Both Delphi and Free Pascal compileres offers the "class helper" support,
eg:

{$IFDEF FPC}
  TObjectHelper = class helper for TObject
  public
    { Returns the qualified name of the class. Example:
@includeCode(../Doc/Parts/TObjectHelper.QualifiedClassName)
{$ENDIF}

Does PasDoc support this feature?

Thank you!

-- 
Silvio Clécio

Re: [Pasdoc-main] What the best way to specify examples?

[silvioprog <sil...@gm...>]

On Wed, Sep 14, 2016 at 7:34 PM, silvioprog <sil...@gm...> wrote:

> On Wed, Sep 14, 2016 at 6:43 PM, Michalis Kamburelis <
> mic...@gm...> wrote:
>
[...]

> 2. There is no way to include a Pascal source file and make it look
>> like a @longCode output, unfortunately. It would be a nice feature,
>> but it's just not done yet. Contributions would be welcome, a tag name
>> like @includeCode would be consistent with our other tags. It should
>> be easy to do:)
>>
>
> ... but the @includeCode seems a very nice feature, and I'm going to try
> to implement that. :-)
>

Done.

Two patches in attachment:

1. Fix-the-warning-APPTYPE-is-not-supported-by-the-targ.patch: just
cosmetic fix
2. includeCode-tag-by-silvioprog.patch: implements the @includeCode feature

I have a Github account, can I share this patches as "pull request" or just
attached in some issue? :-)

-- 
Silvio Clécio

Re: [Pasdoc-main] What the best way to specify examples?

[silvioprog <sil...@gm...>]

On Wed, Sep 14, 2016 at 6:43 PM, Michalis Kamburelis <
mic...@gm...> wrote:
[...]

> There a couple of questions and features here:)
>

Hehe... :-D


> 1. As for the best way to present the longer example code: the
> @longCode tag makes a long code example look pretty (with colors, bold
> keywords etc.), see http://pasdoc.sipsolutions.net/LongcodeTag . The
> result looks like this:
> http://michalis.ii.uni.wroc.pl/castle-engine-snapshots/
> docs/reference/html/CastleImages.html#AddLoadImageListener
> .
>

Yes, I've used @longCode too ...


> 2. There is no way to include a Pascal source file and make it look
> like a @longCode output, unfortunately. It would be a nice feature,
> but it's just not done yet. Contributions would be welcome, a tag name
> like @includeCode would be consistent with our other tags. It should
> be easy to do:)
>

... but the @includeCode seems a very nice feature, and I'm going to try to
implement that. :-)

( is this link the official PasDoc Github repo?:
https://github.com/michaliskambi/pasdoc )


>   What you can do now is to use @include
> http://pasdoc.sipsolutions.net/IncludeTag to include a description
> from another file. But that another file will have to include
> @longCode tag ... So it will not be a correct (compileable) Pascal
> code, if that is what you need.
>
>   And you cannot use @tags within @longCode, so you cannot circumvent
> this limitation by writing "@longCode(#@include(a.pas)#)".
>
>   Hm, I came up with such hack: You can create a compileable file with
> @longCode inside by using comments:
>
> ------ (paste this as aaa.pas)
> // @longCode(#
> begin
>   Writeln('aaa');
> end.
> // #)
> ------
>
>   And then include it with @include(aaa.pas). So it's close to what
> you need... *but* the resulting documentation will have extra "//"
> characters.
>
>   I'm afraid we should just implement a tag like @includeCode to make
> it really Ok.
>
[...]

I didn't know that possibilities. :-o

Thanks for share it.

3. As for linking to a separate page: this is not possible for now.
>
>   Although we have a support for complete, separate documentation
> pages, it is right now used for introduction / conclusion pages:
> http://pasdoc.sipsolutions.net/IntroductionAndConclusion . An example
> output is inside the PasDoc's own documentation:
> http://pasdoc.sourceforge.net/autodoc/html/index.html . The first page
> "Pasdoc Sources Overview" is a separate page written using our @tags .
>
>   However, it is not yet possible to create arbitrary separate
> documentation pages whenever you want. It's another feature that I
> would accept patches for (like an @includePage tag, that can be used
> anywhere within a description, to create new page and also link to
> it).


Great features.

I'm going to try to implement the @includeCode feature, maybe the
@includePage can be a next step hehe.

--
Silvio Clécio

Re: [Pasdoc-main] Update the Copyright header

[silvioprog <sil...@gm...>]

From: Michalis Kamburelis <michalis.kambi@gm...> - 2016-09-14 21:44:43

Thanks for catching this:) I have updated all css,pas,inc,dpr files to
include a copyright ...-2016, and committed a simple shell script to
redo this in the future (source/tools/adjust_copyrights.sh).

Regards,
Michalis


Thank you very much! :-)

-- 
Silvio Clécio

Re: [Pasdoc-main] Update the Copyright header

[Michalis K. <mic...@gm...>]

> Stylizing the pasdoc.css in my project, I found its header:
>
> /*
>   Copyright 1998-2014 PasDoc developers.
> ...
>

Thanks for catching this:) I have updated all css,pas,inc,dpr files to
include a copyright ...-2016, and committed a simple shell script to
redo this in the future (source/tools/adjust_copyrights.sh).

Regards,
Michalis

Re: [Pasdoc-main] What the best way to specify examples?

[Michalis K. <mic...@gm...>]

2016-09-14 18:21 GMT+02:00 silvioprog <sil...@gm...>:
>
> Hello,
>
> I've used the @code feature adding examples to my documentation, however, I don't know if the best approach, because I have some long examples with many lines (~250 lines).
>
[...]
> So I have a question: can I do something like this with PasDoc? If so, can I put an entire existent example the documentation? For example, supposing I have a real example named "MyExample.dpr" in my examples directory, at the documentation directory, I would do:
>
> TSomeClass = class
> public
>   { This is blahblahblah. @example(../Examples/Cosole/MyExample.dpr) }
>   procedure SomeMethod;
> end;
>
> Thank you!
>

There a couple of questions and features here:)

1. As for the best way to present the longer example code: the
@longCode tag makes a long code example look pretty (with colors, bold
keywords etc.), see http://pasdoc.sipsolutions.net/LongcodeTag . The
result looks like this:
http://michalis.ii.uni.wroc.pl/castle-engine-snapshots/docs/reference/html/CastleImages.html#AddLoadImageListener
.

2. There is no way to include a Pascal source file and make it look
like a @longCode output, unfortunately. It would be a nice feature,
but it's just not done yet. Contributions would be welcome, a tag name
like @includeCode would be consistent with our other tags. It should
be easy to do:)

  What you can do now is to use @include
http://pasdoc.sipsolutions.net/IncludeTag to include a description
from another file. But that another file will have to include
@longCode tag ... So it will not be a correct (compileable) Pascal
code, if that is what you need.

  And you cannot use @tags within @longCode, so you cannot circumvent
this limitation by writing "@longCode(#@include(a.pas)#)".

  Hm, I came up with such hack: You can create a compileable file with
@longCode inside by using comments:

------ (paste this as aaa.pas)
// @longCode(#
begin
  Writeln('aaa');
end.
// #)
------

  And then include it with @include(aaa.pas). So it's close to what
you need... *but* the resulting documentation will have extra "//"
characters.

  I'm afraid we should just implement a tag like @includeCode to make
it really Ok.

3. As for linking to a separate page: this is not possible for now.

  Although we have a support for complete, separate documentation
pages, it is right now used for introduction / conclusion pages:
http://pasdoc.sipsolutions.net/IntroductionAndConclusion . An example
output is inside the PasDoc's own documentation:
http://pasdoc.sourceforge.net/autodoc/html/index.html . The first page
"Pasdoc Sources Overview" is a separate page written using our @tags .

  However, it is not yet possible to create arbitrary separate
documentation pages whenever you want. It's another feature that I
would accept patches for (like an @includePage tag, that can be used
anywhere within a description, to create new page and also link to
it).

Regards,
Michalis

[Pasdoc-main] Update the Copyright header

[silvioprog <sil...@gm...>]

Hello,

Stylizing the pasdoc.css in my project, I found its header:

/*
  Copyright 1998-2014 PasDoc developers.
...

You should upgrade it to 1998-2016. :-)

Thanks!

-- 
Silvio Clécio

[Pasdoc-main] What the best way to specify examples?

[silvioprog <sil...@gm...>]

Hello,

I've used the @code feature adding examples to my documentation, however, I
don't know if the best approach, because I have some long examples with
many lines (~250 lines).

I've looked at Delphi help, and noticed the following area:

[image: Inline image 1]

when you click in some link, eg: "Generics Collections TDictionary
(Delphi)", it opens the following area:

[image: Inline image 3]

ie, a specific page showing the full example.

So I have a question: can I do something like this with PasDoc? If so, can
I put an entire existent example the documentation? For example, supposing
I have a real example named "MyExample.dpr" in my examples directory, at
the documentation directory, I would do:

TSomeClass = class
public
  { This is blahblahblah. @example(../Examples/Cosole/MyExample.dpr) }
  procedure SomeMethod;
end;

Thank you!

--
Silvio Clécio

Re: [Pasdoc-main] Question, because "fpdoc" does not generate documentation of a console application.

[Michalis K. <mic...@gm...>]

> I have develop an application console, but when I execute fpdoc, generate
> all documentacion of units of the program, but the main program not.
>
> In the main programa is defined the class:  TMyAppv1 =
> class(TCustomApplication)
>
> which contains functions and procedures, then when generate the docs, this
> functions and procedures not are included.
>
> I use program pasdoc_gui to generate documentation. I check all possible
> options , but not generate information for this program, and I do not know
> what could be happening.
>

(I assume you mean "pasdoc", not "fpdoc". This is a mailing list about
pasdoc development, and "fpdoc" is a different program, although with
similar purpose and also open-source,
http://www.freepascal.org/docs-html/fpdoc/fpdoc.html .)

To answer your question: pasdoc currently parses only the "uses"
clause of the program files. So indeed you will never see the
documentation of any class (and its methods) that is defined inside
the program file. The reason for this is that parsing the
"implementation" section of a unit (which is mostly the same feature
as parsing the inside of a program) is just not implemented in pasdoc.
We want to have this feature, but so far simply noone implemented it
-- see http://pasdoc.sipsolutions.net/WantedFeaturesParsingImplementation
.

Patches / pull requests are most welcome for this!

Until it's implemented, the only solution is to put everything you
want to have documented in some unit's interface.

Best regards,
Michalis

[Pasdoc-main] Question, because "fpdoc" does not generate documentation of a console application.

[Ezequiel B. <ez...@gm...>]

Hello

I have develop an application console, but when I execute fpdoc, generate
all documentacion of units of the program, but the main program not.

In the main programa is defined the class:  TMyAppv1 =
class(TCustomApplication)

which contains functions and procedures, then when generate the docs, this
functions and procedures not are included.

I use program *pasdoc_gui* to generate documentation. I check all
possible options , but not generate information for this program, and I do
not know what could be happening.

Can someone help me please.

Thank you.

Re: [Pasdoc-main] SVN read-only now, moving to GitHub

[silvioprog <sil...@gm...>]

Added in my start list. :-)

Thank you!

On Mon, Mar 7, 2016 at 8:28 PM, Michalis Kamburelis <
mic...@gm...> wrote:

> Hi everyone,
>
> The SVN repository on SourceForge is read-only from now on. The
> commits should be pushed now to our GitHub repository on
> https://github.com/michaliskambi/pasdoc/ . You can follow the "GIT
> way" and just fork PasDoc on GitHub and submit pull requests, or you
> can ask me for push access directly to the above repository.
>
> I'm very open to give push access to everyone interested, in
> particular to the present PasDoc developers on SourceForge! Just send
> me your preferred account/email address on GitHub.
>
> I'm doing this in the hope of getting more exposure, and more
> contributors to our PasDoc project. I'm not a GIT fanboy, but the
> experience with my projects showed that GitHub (and it's workflow of
> "pull requests") really encourages contributions to open-source
> projects.
>
> The commits from GitHub are synchronized (one-way) to SVN using my
> sync2git fork on https://github.com/michaliskambi/sync2git . I used to
> experiment with 2-way synchronization though git-svn, but it was
> bothersome, overriding GIT author information and commit hashes. So to
> be a 1st class citizen on GitHub, we have to embrace it fully, and
> just commit everything through Git and GitHub.
>
> So if you just use our SVN to update (and are not interested in
> committing), you can keep using it, things will work Ok. But I
> encourage you to clone GIT GitHub repo instead, and push some work:)
>
> Note: PasDoc project admins could overcome this restriction and commit
> to SVN anyway --- but please don't do it, as it will probably break
> the synchronization. Instead, really, send me your GitHub
> username/email, and I'll give you push access on GitHub:) Thanks!
>
> Best regards,
> Michalis
>
>
> ------------------------------------------------------------------------------
> Transform Data into Opportunity.
> Accelerate data analysis in your applications with
> Intel Data Analytics Acceleration Library.
> Click to learn more.
> http://makebettercode.com/inteldaal-eval
> _______________________________________________
> Pasdoc-main mailing list
> Pas...@li...
> https://lists.sourceforge.net/lists/listinfo/pasdoc-main
>



-- 
Silvio Clécio