pasdoc-main

[Pasdoc-main] [pasdoc:bugs] #92 Cannot place pasdoc comment after a statement

[Michalis K. <ka...@us...>]

Thank you for the report. Indeed I can  reproduce the problem with latest PasDoc.

We don't use SourceForge bugtracker  anymore, we now use GitHub issue tracker on https://github.com/pasdoc/pasdoc/issues/ . I have added an issue, with a copy of your description and a testcase, to  https://github.com/pasdoc/pasdoc/issues/92 (you can registeron GitHub and "Subscribe" to that issue).


---

** [bugs:#92] Cannot place pasdoc comment after a statement**

**Status:** open
**Version:** 0.15.0
**Created:** Mon Apr 20, 2020 08:46 AM UTC by Bent Vangli
**Last Updated:** Mon Apr 20, 2020 08:46 AM UTC
**Owner:** nobody


If you place a pasdoc comment like this:

{Placeholder for pointer to procedure in main thread.}
 readInfo : procedure(Info : TEventMessage) of object; 
 
 it will work. However, the alternativ with backpointer like:
 
 readInfo : procedure(Info : TEventMessage) of object; //< Placeholder for pointer to procedure in main thread.}
 
 will not. Without the "of object" spesification, it does work.
 
 Regards Bent Vangli
 


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:bugs] #92 Cannot place pasdoc comment after a statement

[Bent V. <va...@us...>]

---

** [bugs:#92] Cannot place pasdoc comment after a statement**

**Status:** open
**Version:** 0.15.0
**Created:** Mon Apr 20, 2020 08:46 AM UTC by Bent Vangli
**Last Updated:** Mon Apr 20, 2020 08:46 AM UTC
**Owner:** nobody


If you place a pasdoc comment like this:

{Placeholder for pointer to procedure in main thread.}
 readInfo : procedure(Info : TEventMessage) of object; 
 
 it will work. However, the alternativ with backpointer like:
 
 readInfo : procedure(Info : TEventMessage) of object; //< Placeholder for pointer to procedure in main thread.}
 
 will not. Without the "of object" spesification, it does work.
 
 Regards Bent Vangli
 


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #60 Follow nested record types

[Michalis K. <ka...@us...>]

I agree, `@link(Two.a)` should also work eventually :) 


---

** [feature-requests:#60] Follow nested record types**

**Status:** open
**Group:** 
**Created:** Mon Dec 31, 2018 07:01 AM UTC by Colin Haywood
**Last Updated:** Mon Dec 31, 2018 10:19 PM UTC
**Owner:** nobody


Easiest explained with an example:

~~~
  // Record Two.
  TRecord2 = record
    // An exciting value.
    a: integer;
  end;

  // Record One.
  TRecord1 = record
    // The record2.
    Two: TRecord2;

    // Must be @true if @link(Two.a) is bigger than @code(10).
    x: boolean;
  end;
~~~

The pasdoc parser complains that it can't understand the link "Two.a":

`Warning[1]: Could not resolve link "Two.a" (from description of "pasdocrecordtest.TRecord1.x")`

It seems pasdoc can only identify fields of top-level records by name, not fields of nested records. This is a shame, as it means you have to refer to nested fields by their parent types, which is much less clear for  the end-user. Hopefully it would not be too hard to add the ability to follow chains of nested records by their field names.


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #60 Follow nested record types

[Colin H. <ahy...@us...>]

Since the link tag can link to fields, should it not also be able to link to fields of nested records (which are essentially  fields of the parent record, but with a hierarchical name)? Only having to write the name of the field would make the documentation far easier to maintain.

I'd agree the two cases you've shown in your class testcase look like bugs.


---

** [feature-requests:#60] Follow nested record types**

**Status:** open
**Group:** 
**Created:** Mon Dec 31, 2018 07:01 AM UTC by Colin Haywood
**Last Updated:** Mon Dec 31, 2018 04:03 PM UTC
**Owner:** nobody


Easiest explained with an example:

~~~
  // Record Two.
  TRecord2 = record
    // An exciting value.
    a: integer;
  end;

  // Record One.
  TRecord1 = record
    // The record2.
    Two: TRecord2;

    // Must be @true if @link(Two.a) is bigger than @code(10).
    x: boolean;
  end;
~~~

The pasdoc parser complains that it can't understand the link "Two.a":

`Warning[1]: Could not resolve link "Two.a" (from description of "pasdocrecordtest.TRecord1.x")`

It seems pasdoc can only identify fields of top-level records by name, not fields of nested records. This is a shame, as it means you have to refer to nested fields by their parent types, which is much less clear for  the end-user. Hopefully it would not be too hard to add the ability to follow chains of nested records by their field names.


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #59 Ignore entire .inc files

[Colin H. <ahy...@us...>]

That would be an awesome feature, thanks.


---

** [feature-requests:#59] Ignore entire .inc files**

**Status:** open
**Group:** 
**Created:** Mon Dec 31, 2018 06:51 AM UTC by Colin Haywood
**Last Updated:** Mon Dec 31, 2018 04:06 PM UTC
**Owner:** nobody


It would be good if you could ignore an entire .inc file, e.g. by placing the @exclude tag next to the {$I filename.inc} directive, or perhaps a new file-specific tag like @excludefile placed at the top of a file.


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #59 Ignore entire .inc files

[Michalis K. <ka...@us...>]

I would prefer to fix it with `@excludeBegin` and `@excludeEnd` options, already planned. They cover more use-cases, and also would satisfy this one. You would be able to write e.g.

```pascal
{ @excludeBegin }
{$I myinclude.inc}
{ @excludeEnd }
```

to have everything inside your include file ignored. You could also place the `@excludeBegin/End` inside the `myinclude.inc` file.


---

** [feature-requests:#59] Ignore entire .inc files**

**Status:** open
**Group:** 
**Created:** Mon Dec 31, 2018 06:51 AM UTC by Colin Haywood
**Last Updated:** Mon Dec 31, 2018 06:51 AM UTC
**Owner:** nobody


It would be good if you could ignore an entire .inc file, e.g. by placing the @exclude tag next to the {$I filename.inc} directive, or perhaps a new file-specific tag like @excludefile placed at the top of a file.


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #60 Follow nested record types

[Michalis K. <ka...@us...>]

The `@link` should lead to `@link(TRecord2.a)`, not `@link(Two.a)`.

In order to link to `TRecord2.a` but show it as `Two.a`, you can write `@link(TRecord2.a Two.a)`, see https://github.com/pasdoc/pasdoc/wiki/LinkTag .

That said, indeed it isn't working with the nested record as it should. I'm attaching a testcase I made, based on your code, and indeed it uncovers two situations that don't work as they should. The problem is most likely in PasDoc's `TPasItem.FindNameWithinUnit` method -- it's way too simple :), it was never updated to understand nested structure types.

I'll look into this when I'll find a bit time, that's probably next year :) Thanks for the report!


Attachments:

- [testunit.pas](https://sourceforge.net/p/pasdoc/feature-requests/_discuss/thread/1852b8931a/40d0/attachment/testunit.pas) (1.0 kB; text/x-pascal)


---

** [feature-requests:#60] Follow nested record types**

**Status:** open
**Group:** 
**Created:** Mon Dec 31, 2018 07:01 AM UTC by Colin Haywood
**Last Updated:** Mon Dec 31, 2018 07:01 AM UTC
**Owner:** nobody


Easiest explained with an example:

~~~
  // Record Two.
  TRecord2 = record
    // An exciting value.
    a: integer;
  end;

  // Record One.
  TRecord1 = record
    // The record2.
    Two: TRecord2;

    // Must be @true if @link(Two.a) is bigger than @code(10).
    x: boolean;
  end;
~~~

The pasdoc parser complains that it can't understand the link "Two.a":

`Warning[1]: Could not resolve link "Two.a" (from description of "pasdocrecordtest.TRecord1.x")`

It seems pasdoc can only identify fields of top-level records by name, not fields of nested records. This is a shame, as it means you have to refer to nested fields by their parent types, which is much less clear for  the end-user. Hopefully it would not be too hard to add the ability to follow chains of nested records by their field names.


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #60 Follow nested record types

[Colin H. <ahy...@us...>]

---

** [feature-requests:#60] Follow nested record types**

**Status:** open
**Group:** 
**Created:** Mon Dec 31, 2018 07:01 AM UTC by Colin Haywood
**Last Updated:** Mon Dec 31, 2018 07:01 AM UTC
**Owner:** nobody


Easiest explained with an example:

~~~
  // Record Two.
  TRecord2 = record
    // An exciting value.
    a: integer;
  end;

  // Record One.
  TRecord1 = record
    // The record2.
    Two: TRecord2;

    // Must be @true if @link(Two.a) is bigger than @code(10).
    x: boolean;
  end;
~~~

The pasdoc parser complains that it can't understand the link "Two.a":

`Warning[1]: Could not resolve link "Two.a" (from description of "pasdocrecordtest.TRecord1.x")`

It seems pasdoc can only identify fields of top-level records by name, not fields of nested records. This is a shame, as it means you have to refer to nested fields by their parent types, which is much less clear for  the end-user. Hopefully it would not be too hard to add the ability to follow chains of nested records by their field names.


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #59 Ignore entire .inc files

[Colin H. <ahy...@us...>]

---

** [feature-requests:#59] Ignore entire .inc files**

**Status:** open
**Group:** 
**Created:** Mon Dec 31, 2018 06:51 AM UTC by Colin Haywood
**Last Updated:** Mon Dec 31, 2018 06:51 AM UTC
**Owner:** nobody


It would be good if you could ignore an entire .inc file, e.g. by placing the @exclude tag next to the {$I filename.inc} directive, or perhaps a new file-specific tag like @excludefile placed at the top of a file.


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #57 improve build time testing

[Michalis K. <ka...@us...>]

- **status**: open --> closed
- **assigned_to**: Michalis Kamburelis
- **Group**:  --> 



---

** [feature-requests:#57] improve build time testing**

**Status:** closed
**Group:** 
**Created:** Fri May 16, 2014 10:38 AM UTC by Paul Gevers
**Last Updated:** Tue Mar 20, 2018 09:13 PM UTC
**Owner:** Michalis Kamburelis


To improve build time testing (e.g. done in the (nearly finished) Debian package) it would be nice if the following features would be implemented:

- top level Makefile aware of (some of) the tests/Makefile targets.

- shipping of the reference files in the pasdoc package.

- ensure non-zero return value if results are not as expected. Currently the tests pass, even when pasdoc, xmllint and onsgmls are not on the path or installed.



---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:feature-requests] #57 improve build time testing

[Michalis K. <ka...@us...>]

All done:)

AD 2 ("shipping of the reference files in the pasdoc package") - The correct tests output is now trivially kept inside our code repository (GIT on https://github.com/pasdoc/pasdoc , auto-synchronized with SVN repository on SourceForge). In `tests/testcases_output/`, documented in tests/README.md, see https://github.com/pasdoc/pasdoc/tree/master/tests .

It was more critical now, as SourceForge doesn't allow creating shells anymore, which was breaking our "upload_correct_tests_output.sh" script.

The new solution avoids any downloading/uploading on SourceForge servers. And no packing to tar.gz. We can also easily check changes by just `git diff`, and commit them with `git commit`. So, overall, we avoid maintaining some of our scripts, and hopefully the simplicity of the new solution is a win :)

AD 1 ("top level Makefile aware of (some of) the tests/Makefile targets.") - To run all the tests, just execute `make tests` now. This is a trivial shortcut to executing `run_all_tests.sh` inside the `tests/` subdirectory.

Note that it compares correctness using `git diff --exit-code testcases_output/` by default. If you have sources without the `.git` repository data, then define USE_DIFF_TO_COMPARE=true first, like:

```
export USE_DIFF_TO_COMPARE=true
make tests
```

AD 3 ("ensure non-zero return value if results are not as expected") - I believe this was solved by your recent patch that added `which` checks to the scripts :)



---

** [feature-requests:#57] improve build time testing**

**Status:** open
**Group:** 
**Created:** Fri May 16, 2014 10:38 AM UTC by Paul Gevers
**Last Updated:** Wed May 21, 2014 08:35 PM UTC
**Owner:** nobody


To improve build time testing (e.g. done in the (nearly finished) Debian package) it would be nice if the following features would be implemented:

- top level Makefile aware of (some of) the tests/Makefile targets.

- shipping of the reference files in the pasdoc package.

- ensure non-zero return value if results are not as expected. Currently the tests pass, even when pasdoc, xmllint and onsgmls are not on the path or installed.



---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

Re: [Pasdoc-main] PasDoc 0.15.0 released

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

P.P.S. The new version can be downloaded from the usual place --
https://sourceforge.net/projects/pasdoc/files/ .

Or just grab the sources from GitHub and compile them yourself:
https://github.com/pasdoc/pasdoc/ .

Regards,
Michalis

[Pasdoc-main] PasDoc 0.15.0 released

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

Hi everyone,

PasDoc 0.15.0 was just released! This release contains a number of new
features and bugfixes done in the last... wow, 2.5 years.

Here they are (quoting from
https://github.com/pasdoc/pasdoc/blob/master/ChangeLog ):

* @links to enumerated type members work now.

* New @includeCode tag
https://github.com/pasdoc/pasdoc/wiki/IncludeCodeTag (by Silvio
Clécio)

* @longCode and @preformatted improved to better honor indentation.

* Parsing "experimental" directive.

* Allow to customize HTML output more, with your own CSS and HTML, by
--html-head, --html-body-begin, --html-body-end command-line params.

* HTML output is now HTML5.

* Add our tools to the binary release: pascal_pre_proc (Pascal
preprocessor), file_to_pascal_data, file_to_pascal_string.

* Improve CSS and HTML, in particular for accessibility and mobile
browsers. Among many improvements, we removed fixed font size in
pixels, changed some tables into divs, and fixed HTML validity around
Tipue search box.

* pasdoc_gui uses now default font size on your system.

* Updated Spanish (Spain) translation (by Guillermo Martínez Jiménez)

* Tipue works now more efficiently -- the (potentially large) "index
data" is only loaded on the "Search Results" page.

* Automatic tests rearrangements and simplifications (see
tests/run_all_tests.sh).

Thank you to everyone who contributed to this release, and to everyone
who uses PasDoc.

P.S. We may not be the most active open-source project, but we're
still alive:) Personally, I use PasDoc daily to generate documentation
for Castle Game Engine (
https://castle-engine.sourceforge.io/apidoc/html/index.html ).

Regards,
Michalis

[Pasdoc-main] [pasdoc:bugs] #73 Error with Class Operators

[Michalis K. <ka...@us...>]

- **status**: open --> closed
- **assigned_to**: Michalis Kamburelis
- **Version**:  --> 0.13.0



---

** [bugs:#73] Error with Class Operators**

**Status:** closed
**Version:** 0.13.0
**Labels:** parser (Delphi 200x features) 
**Created:** Tue Apr 28, 2009 05:45 PM UTC by Jakob Wenzel
**Last Updated:** Thu Feb 08, 2018 10:25 PM UTC
**Owner:** Michalis Kamburelis


When parsing a record with class operators like this, an error is generated and the whole file is not included:
class operator Add(p1,p2:TMyPoint):TMyPoint;
The error message is as follows:
Error EPasDoc: F:\Delphi\jdvd\trunc\common\uPersons.pas(14): One of symbols "," or ":" expected while parsing unit uPersons.pas, continuing...


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:bugs] #73 Error with Class Operators

[Michalis K. <ka...@us...>]

Closing, this was fixed long time ago:

```
unit A;
interface
type
  TMyRecord = record
    class operator Add(p1,p2:TMyPoint):TMyPoint;
  end;
implementation
end.
```

Sorry for not notifying about it earlier!


---

** [bugs:#73] Error with Class Operators**

**Status:** open
**Version:** 
**Labels:** parser (Delphi 200x features) 
**Created:** Tue Apr 28, 2009 05:45 PM UTC by Jakob Wenzel
**Last Updated:** Mon Nov 05, 2012 10:18 AM UTC
**Owner:** nobody


When parsing a record with class operators like this, an error is generated and the whole file is not included:
class operator Add(p1,p2:TMyPoint):TMyPoint;
The error message is as follows:
Error EPasDoc: F:\Delphi\jdvd\trunc\common\uPersons.pas(14): One of symbols "," or ":" expected while parsing unit uPersons.pas, continuing...


---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:bugs] #88 Include files

[Michalis K. <ka...@us...>]

- **status**: open --> closed



---

** [bugs:#88] Include files**

**Status:** closed
**Version:** 0.13.0
**Created:** Sun Nov 08, 2015 09:25 PM UTC by Benito van der Zander
**Last Updated:** Thu Feb 08, 2018 10:22 PM UTC
**Owner:** nobody


It does not like to be applied to include files:

    Info[2]:    Now parsing file data/xquery_schemas.inc...
    Warning[2]: Error EPasDoc: data/xquery_schemas.inc(2): reserved word "library" expected but reserved word "const" found while parsing unit xquery_schemas.inc, continuing...
    Info[2]:    Now parsing file data/xquery_types.inc...
    Warning[2]: Error EPasDoc: data/xquery_types.inc(1): reserved word "library" expected but reserved word "class" found while parsing unit xquery_types.inc, continuing...
    Info[2]:    Now parsing file data/xquery_functions_generated_template.inc...
    Warning[2]: Error EPasDoc: data/xquery_functions_generated_template.inc(1): reserved word "library" expected but reserved word "function" found while parsing unit xquery_functions_generated_template.inc, continuing...



---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Pasdoc-main] [pasdoc:bugs] #88 Include files

[Michalis K. <ka...@us...>]

Closing -- not a bug in PasDoc, we do not parse include files indeed:)


---

** [bugs:#88] Include files**

**Status:** open
**Version:** 0.13.0
**Created:** Sun Nov 08, 2015 09:25 PM UTC by Benito van der Zander
**Last Updated:** Tue Nov 10, 2015 09:09 AM UTC
**Owner:** nobody


It does not like to be applied to include files:

    Info[2]:    Now parsing file data/xquery_schemas.inc...
    Warning[2]: Error EPasDoc: data/xquery_schemas.inc(2): reserved word "library" expected but reserved word "const" found while parsing unit xquery_schemas.inc, continuing...
    Info[2]:    Now parsing file data/xquery_types.inc...
    Warning[2]: Error EPasDoc: data/xquery_types.inc(1): reserved word "library" expected but reserved word "class" found while parsing unit xquery_types.inc, continuing...
    Info[2]:    Now parsing file data/xquery_functions_generated_template.inc...
    Warning[2]: Error EPasDoc: data/xquery_functions_generated_template.inc(1): reserved word "library" expected but reserved word "function" found while parsing unit xquery_functions_generated_template.inc, continuing...



---

Sent from sourceforge.net because pas...@li... is subscribed to https://sourceforge.net/p/pasdoc/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/pasdoc/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

Re: [Pasdoc-main] PasDoc

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

Indeed it's best to use @tags, as they provide all the PasDoc features.

However, PasDoc can also parse (some) Delphi "Help Insight" comments.
The parsing has some limitations (internally, it uses simple
regular-expressions to turn Help Insight things, like
"<summary>123</summary>" into "@abstract(123)")... but works in simple
cases. So, "///<summary>123</summary>" should also work in PasDoc. See
https://github.com/pasdoc/pasdoc/wiki/WritingDocumentation#-help-insight-comments
for details.

Please double-check you're using the correct spelling (in the email,
it seems you're closing with "</summy>" instead of "</summary>").

If it still doesn;t work, please submit an exact testcase that doesn't
work. We'll be able to help you better then:)

Regards,
Michalis


2018-02-02 15:43 GMT+01:00 Winston, Richard <rb...@us...>:
> There is a mailing list for PasDoc. You can find a link to it at
> https://github.com/pasdoc/pasdoc/wiki . The mailing list is a good place to
> send questions about PasDoc
>
> PasDoc is not designed to to use Delphi Help Insight comments. To do what
> you want you would write
> // @abstract(123).
> There is a list of supported tags at
> https://github.com/pasdoc/pasdoc/wiki/SupportedTags .
>
> On Fri, Feb 2, 2018 at 6:40 AM, ido...@ou...
> <ido...@ou...> wrote:
>>
>> Hi:
>>
>>        I come from china, and I am a learner in the first stage in delphi,
>> I ues pasdoc to build my own doc, its very useful, and when I build the
>> project, it doesn’t work well, delphi Help Insight commentscan not be
>> analysed,such as I write ///<summary>123</summy>, in the html page, it shows
>> “<summary>123</summy>”. I write this emai to ask you for help. I am sorry to
>> bother you, but I can not find help in the file and internet and I am so
>> confused.
>>
>>        Thank you very much.
>>
>>
>>
>> 发送自 Windows 10 版邮件应用
>>
>>
>
>
>
>
> --
>
> Richard B. Winston
> rb...@us...
> https://profile.usgs.gov/rbwinst
> 703-648-5988
> on Wednesdays: 301 474-2762
> Fax: 703 648-5274
>
> The following are excellent guides especially for beginning modelers.
> Reilly, T.E., 2001, System and boundary conceptualization in ground-water
> flow simulation:  U.S. Geological Survey Techniques of Water-Resources
> Investigations, book 3, chap. B8, 30 p.
> https://water.usgs.gov/pubs/twri/twri-3_B8/
>
> Reilly, T.E., and Harbaugh, A.W., 2004 , Guidelines for evaluating
> ground-water flow models: U.S. Geological Survey Scientific Investigations
> Report 2004-5038, 30 p.
> https://pubs.usgs.gov/sir/2004/5038/
>
>
> "Codes only live if somebody loves them." Matt Tonkin, June 2, 2015, MODFLOW
> and More 2015 Conference Panel Discussion.
>
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Pasdoc-main mailing list
> Pas...@li...
> https://lists.sourceforge.net/lists/listinfo/pasdoc-main
>

Re: [Pasdoc-main] PasDoc

[Winston, R. <rb...@us...>]

There is a mailing list for PasDoc. You can find a link to it at
https://github.com/pasdoc/pasdoc/wiki . The mailing list is a good place to
send questions about PasDoc

PasDoc is not designed to to use Delphi Help Insight comments. To do what
you want you would write
// @abstract(123).
There is a list of supported tags at
https://github.com/pasdoc/pasdoc/wiki/SupportedTags .

On Fri, Feb 2, 2018 at 6:40 AM, ido...@ou... <
ido...@ou...> wrote:

> Hi:
>
>        I come from china, and I am a learner in the first stage in delphi,
> I ues pasdoc to build my own doc, its very useful, and when I build the
> project, it doesn’t work well, delphi *Help Insight comments*can not be
> analysed,such as I write ///<summary>123</summy>, in the html page, it
> shows “<summary>123</summy>”. I write this emai to ask you for help. I am
> sorry to bother you, but I can not find help in the file and internet and I
> am so confused.
>
>        Thank you very much.
>
>
>
> 发送自 Windows 10 版邮件 <https://go.microsoft.com/fwlink/?LinkId=550986>应用
>
>
>



-- 

Richard B. Winston
rb...@us...
https://profile.usgs.gov/rbwinst <http://water.usgs.gov/nrp/gwsoftware/>
703-648-5988
on Wednesdays: 301 474-2762
Fax: 703 648-5274

The following are excellent guides especially for beginning modelers.
Reilly, T.E., 2001, System and boundary conceptualization in ground-water
flow simulation:  U.S. Geological Survey Techniques of Water-Resources
Investigations, book 3, chap. B8, 30 p.
https://water.usgs.gov/pubs/twri/twri-3_B8/
<http://water.usgs.gov/pubs/twri/twri-3_B8/>

Reilly, T.E., and Harbaugh, A.W., 2004 , Guidelines for evaluating
ground-water flow models: U.S. Geological Survey Scientific Investigations
Report 2004-5038, 30 p.
https://pubs.usgs.gov/sir/2004/5038/


"Codes only live if somebody loves them." Matt Tonkin, June 2, 2015,
MODFLOW and More 2015 Conference Panel Discussion.

[Pasdoc-main] "experimental" hint directive

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

Hi,

I implemented simple handling of the "experimental" hint directive
available in the latest FPC and Delphi (see e.g.
https://wiert.me/2014/10/01/delphi-hinting-directives-deprecated-experimental-library-and-platform/
).

E.g. this will be parsed OK now by PasDoc:

~~~~
unit TestUnit;

interface

var
  A: Integer experimental;

implementation
end.
~~~~

Regards,
Michalis

[Pasdoc-main] Links to enumerated type members

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

Links to enumerated type members are now working. So you can do this:

----
type
  TMyEnum = (
    { Some value docs. }
    meSomeValue,
    { Some other value docs. }
    meSomeOtherValue
  );

{ You can now link to enum member: @link(meSomeValue). }
procedure Foo;
----

See also https://github.com/pasdoc/pasdoc/blob/master/tests/ok_enum_links.pas

Regards,
Michalis

Re: [Pasdoc-main] HTML5, --html-head/body options, Tipue improvements

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

Hello dude,

Thanks for releasing it, it is really great news. Today I'm working in a C
library and documenting it with Doxygen, but I'll be back to PasDoc as soon
as I return to my projects in Pascal! :-)

Thank you!

On Tue, Feb 28, 2017 at 11:45 PM, Michalis Kamburelis <
mic...@gm...> wrote:

> Hi,
>
> Some new features and improvements!
>
> 1. Our HTML output is now HTML5 -- it uses HTML5 doctype, and avoids
> some deprecated things. This makes it easy to integrate our output
> with modern things prepared for HTML5, like Bootstrap.
>
> 2. I added command-line options --html-head, --html-body-begin,
> --html-body-end .
>
>   --html-head adds content inside HTML <head> element. E.g. links to
> additional CSS files.
>   --html-body-begin adds content right after <body>.
>   --html-body-end adds content right before </body>.
>
>   They are documented in more details on
> https://github.com/pasdoc/pasdoc/wiki/HtmlHeadBodyBeginEndOptions .
>
>   Together, these options can be used to customize the output HTML
> pages in many ways. See for example my Castle Game Engine API
> reference on:
>
>   https://castle-engine.sourceforge.io/apidoc/html/introduction.html
>
>   Using the above options, the API reference generated by PasDoc looks
> a bit like the normal part of the Castle Game Engine (
> https://castle-engine.sourceforge.io/ ) webpage, with normal
> navigation and styling.
>
> 3. I improved the Tipue working: it now references the (large)
> "tipuesearch_data.js" only on the "Search Results" page. This means
> that Tipue doesn't cause a slowdown when browsing your documentation
> -- the search data is loaded only when really necessary, when you
> initiated some search.
>
>   I also reworked the docs on
> https://github.com/pasdoc/pasdoc/wiki/UseTipueSearchOption .
>
> Best regards,
> Michalis
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, SlashDot.org! http://sdm.link/slashdot
> _______________________________________________
> Pasdoc-main mailing list
> Pas...@li...
> https://lists.sourceforge.net/lists/listinfo/pasdoc-main
>



-- 
Silvio Clécio

[Pasdoc-main] HTML5, --html-head/body options, Tipue improvements

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

Hi,

Some new features and improvements!

1. Our HTML output is now HTML5 -- it uses HTML5 doctype, and avoids
some deprecated things. This makes it easy to integrate our output
with modern things prepared for HTML5, like Bootstrap.

2. I added command-line options --html-head, --html-body-begin,
--html-body-end .

  --html-head adds content inside HTML <head> element. E.g. links to
additional CSS files.
  --html-body-begin adds content right after <body>.
  --html-body-end adds content right before </body>.

  They are documented in more details on
https://github.com/pasdoc/pasdoc/wiki/HtmlHeadBodyBeginEndOptions .

  Together, these options can be used to customize the output HTML
pages in many ways. See for example my Castle Game Engine API
reference on:

  https://castle-engine.sourceforge.io/apidoc/html/introduction.html

  Using the above options, the API reference generated by PasDoc looks
a bit like the normal part of the Castle Game Engine (
https://castle-engine.sourceforge.io/ ) webpage, with normal
navigation and styling.

3. I improved the Tipue working: it now references the (large)
"tipuesearch_data.js" only on the "Search Results" page. This means
that Tipue doesn't cause a slowdown when browsing your documentation
-- the search data is loaded only when really necessary, when you
initiated some search.

  I also reworked the docs on
https://github.com/pasdoc/pasdoc/wiki/UseTipueSearchOption .

Best regards,
Michalis

Re: [Pasdoc-main] New PasDoc website (wiki) on GitHub!

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

New year with good news! :-)

Thank you!

On Sun, Jan 8, 2017 at 1:16 AM, Michalis Kamburelis <
mic...@gm...> wrote:

> Hi everyone!
>
> Our wiki, which serves as our main website, has been moved to
>
>   https://github.com/michaliskambi/pasdoc/wiki
>
> Please take a look, and update your bookmarks:)
>
> The new wiki was converted from the MoinMoin content (somewhat
> automatically, and then I did a lot of manual fixes:). Along the way,
> I improved and cleaned up some pages. I hope that the new sidebar is
> also helpful: it's a prominent "table of contents" for the wiki,
> visible on every page. At the end, we have 99 (exactly!) pages in our
> wiki:)
>
> Please take a look, and report if you find anything incorrect. Or,
> even better, go ahead and fix it yourself!:) It's a wiki, and it
> should be open for public editing (you should only need a GitHub
> account; please email me if it doesn't work).
>
> Why:
>
> Our previous wiki (now retired), was hosted on
> http://pasdoc.sipsolutions.net/ . It was using the MoinMoin wiki
> engine. Johannes Berg was administering the server and MoinMoin.
> Johannes was also the main PasDoc developer for some time, he
> restarted the PasDoc project on SourceForge, so he really deserves a
> thousand thanks!:)
>
> Two independent reasons pushed us to switch from MoinMoin to a GitHub wiki:
>
> 1. The MoinMoin engine started to be somewhat problematic on the
> server, eating too much CPU for too long, on some occasions. So,
> Johannes decided it's time to move away from MoinMoin.
>
> 2. At around the same time, Michalis became a fan of the Asciidoctor
> as a full-featured, but also super-easy to use, documentation format.
> And I realized that we could use Asciidoctor to generate offline
> PasDoc documentation in the future, if we use the GitHub wiki. Two
> killer features of GitHub wiki for us:
>
> - GitHub wiki allows to host the pages in the Asciidoctor format. So
> we can have online (wiki) and offline documentation generated from the
> same Asciidoctor sources, without any lossy conversions along the way.
>
> - GitHub wiki can be cloned and modified as a regular Git repository.
> This allows to do a lot of things comfortably. You can get the
> Asciidoctor files, run asciidoctor-pdf on them, and trivially easy get
> a PDF with PasDoc manual.
>
> So with a simple script, we may get a sleek PasDoc offline manual, in
> HTML and PDF. It's not done yet, but I think it will be trivially
> easy, whenever I'll find a time to attack this:)
>
> Enjoy!
>
> P.S. Who remembered that we have a "Star Wars" logo on the
> https://github.com/michaliskambi/pasdoc/wiki/PreformattedTag page?:)
>
> Regards,
> Michalis
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, SlashDot.org! http://sdm.link/slashdot
> _______________________________________________
> Pasdoc-main mailing list
> Pas...@li...
> https://lists.sourceforge.net/lists/listinfo/pasdoc-main
>



-- 
Silvio Clécio

Re: [Pasdoc-main] New PasDoc website (wiki) on GitHub!

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

2017-01-08 5:16 GMT+01:00 Michalis Kamburelis <mic...@gm...>:
> Hi everyone!
>
> Our wiki, which serves as our main website, has been moved to
>
>   https://github.com/michaliskambi/pasdoc/wiki
>
> Please take a look, and update your bookmarks:)
>

Update: our code repository, and wiki, was moved under the "pasdoc"
organization (instead of being part of my profile on github,
"michaliskambi"). So the *new* wiki address is

  https://github.com/pasdoc/pasdoc/wiki

and the new code (GIT) clone URL is

  https://github.com/pasdoc/pasdoc.git

This looks much better:) GitHub is nicely redirecting traffic from
michaliskambi/pasdoc -> pasdoc/pasdoc, even for access through GIT, so
old links will work too.

Also, interested developers: please let me know your username on
GitHub, so I can add you to the developers of the repository!

Regards,
Michalis