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
>