Activity for pasdoc
-
Michalis Kamburelis created a blog post
PasDoc 1.0.0 released
-
Inherited comments, @implements tag
-
Comments from inherited things are now used for classes and class members. Realistically, this is an old patch which will not apply anymore. If anything is missing from latest PasDoc, please submit PR to the latest code on GitHub: https://github.com/pasdoc/pasdoc/pulls
-
add a wiki "markup" parser
-
We have Markdown syntax now, which addresses this issue I believe: https://pasdoc.github.io/MarkdownOption
-
Parsed store persistence
-
Closing -- the original thread (linked from description of this issue) is not available anymore, and I think we have addressed everything we practically want from this :) In particular, format-independent cache in PasDoc rocks.
-
4 question....
-
Summary: I treat this request as partially fixed. The only remaining issue here is number 2: using @created, @author and @lastmod for all items. This has been done long time ago :) @created, @author, @lastmod work for all items. Other points from this were addressed already, from what I can see. Closing:)
-
JavaDoc-like Tag handling
-
Parsing implementation comments is done: https://pasdoc.github.io/ImplementationCommentsOption
-
Including inherited class methods in documentation
-
This was implemented recently:) See https://github.com/pasdoc/pasdoc/discussions/240
-
Support of @member in constante comment
-
I don't think we want to allow @member for this -- the idea of@member is to refer to existing member of given structure, https://pasdoc.github.io/MemberValueTag . The way to express what you need is indeed to use general formatting, like @unorderedList.
-
Parse Comments in Implementation Section
-
Parsing implementations is available in PasDoc for some time now: https://pasdoc.github.io/ImplementationCommentsOption . Closing.
-
Support for interface realization
-
Interfaces are part of "hierarchy". What interfaces are implemented by a given class is visible in that class docs, and in GraphViz graph (we cannot really show this in "hierarchy" since a class may implement multiple interfaces). Closing - I think realistically we have implemented what is necessary. If anything remains, please submit a GitHub issue: https://github.com/pasdoc/pasdoc/issues
-
HTML-5 support
-
Done now in PasDoc 1.0.0: https://github.com/pasdoc/pasdoc/discussions/230
-
Explicit @link doesn't work with urls
-
We've made a separate @ tag for URL links: https://pasdoc.github.io/UrlTag . This practically addresses this issue. We didn't "overuse" @ link to handle URLs, to keep things easier: @link is for Pascal items, @url is for URLs.
-
Follow nested record types
-
We have improved parsing nesting structures and linking to them in PasDoc 1.0.0, see https://github.com/pasdoc/pasdoc/blob/master/ChangeLog.md . So this should be fixed, please retest. If anything remains missing, please report on GitHub issues, https://github.com/pasdoc/pasdoc/issues . Thank you!
-
auto link and duplicated names
-
We have improved resolving qualified identifiers in PasDoc 1.0.0 , see also our changelog https://github.com/pasdoc/pasdoc/blob/master/ChangeLog.md . So this case is likely handled correctly now --- but please retest. If it doesn't work, please create a new issue in GitHub issues on https://github.com/pasdoc/pasdoc/issues with exact testcase, I'll fix :) Thank you!
-
@exclude doesn't work for any class elements described inside other class
-
The @exclude tag was fixed to be more complete for PasDoc 1.0.0, and this is now handled OK. Note that in the testcase above, comment "// this doesn't work, TEnumerator is still documented" will obscure the previous "@exclude" comment, which is by design (one comment obscures earlier one). This works correctly: unit a; interface type TSomeClass = class public type // works now, will be excluded {@exclude} TEnumerator = class public // also works now, will be excluded, even if TEnumerator would remain...
-
The @exclude tag was fixed to be more complete for PasDoc 1.0.0, and this is now handled OK. Note that in the testcase above, comment "// this doesn't work, TEnumerator is still documented" will obscure the previous "@exclude" comment, which is by design (one comment obscures earlier one). This works correctly: unit a; interface type TSomeClass = class public type // this doesn't work, TEnumerator is still documented {@exclude} TEnumerator = class public // The following doesn't work either, constructor...
-
The @exclude tag was fixed to be more complete for PasDoc 1.0.0, and this is now handled OK. Note that in the testcase above, comment "// this doesn't work, TEnumerator is still documented" will obscure the previous "@exclude" comment, which is by design (one comment obscures earlier one). This works correctly: """" unit a; interface type TSomeClass = class public type // this doesn't work, TEnumerator is still documented {@exclude} TEnumerator = class public // The following doesn't work either,...
-
Incorrect output when you declare one record within another
-
We have done a lot of parsing improvements around PasDoc 1.0.0, also for nested structures (records within other CIOs). I think this is fixed :) Check out https://pasdoc.github.io/ for latest PasDoc.
-
overload and jump
-
This is addressed now by new capabilities of @link that allow to link to specific overload, see https://pasdoc.github.io/LinkTag .
-
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).
-
Bent Vangli created ticket #92
Cannot place pasdoc comment after a statement
-
I agree, @link(Two.a) should also work eventually :)
-
Colin Haywood posted a comment on ticket #60
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.
-
That would be an awesome feature, thanks.
-
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. { @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.
-
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 :),...
-
Follow nested record types
-
Ignore entire .inc files
-
Simplify exception catching, exit with non-zero status (by Michalis Kamburelis)
-
Testcase for @param and @raises on properties (by Michalis Kamburelis)
-
Mention tests upgrades (by Michalis Kamburelis)
-
improve build time testing
-
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....
-
Keep testcases_output inside GIT repository (by Michalis Kamburelis)
-
ChangeLog update (by Michalis Kamburelis)
-
Update links to PasDoc wiki and aspell.net (by Michalis Kamburelis)
-
Show visibility inside records too (by Michalis Kamburelis)
-
Add de.utf8 language: German in UTF-8 encoding (by Michalis Kamburelis)
-
Fix section title (by Michalis Kamburelis)
-
PasDoc 0.15.0 released
-
PasDoc 0.15.0 released
-
PasDoc 0.15.0 released
-
"make tag" helper command (by Michalis Kamburelis)
-
Error with Class Operators
-
Closing, this was fixed long time ago. PasDoc can parse this: unit A; interface type TMyRecord = record class operator Add(p1,p2:TMyPoint):TMyPoint; end; implementation // ... end. Sorry for not notifying about it earlier!
-
Closing, this was fixed long time ago. PasDoc can parse this: unit A; interface type TMyRecord = record class operator Add(p1,p2:TMyPoint):TMyPoint; end; implementation end. Sorry for not notifying about it earlier!
-
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!
-
Include files
-
Closing -- not a bug in PasDoc, we do not parse include files indeed:)
-
pasdoc released /PasDoc Source/pasdoc-0.15.0-src.tar.gz
-
-
-
Fix Markdown more (by Michalis Kamburelis)
-
tests/README.md using Markdown (by Michalis Kamburelis)
-
Remove BrowserCommand from delphi_gui (by Michalis Kamburelis)
-
Parse "experimental" hint directive (by Michalis Kamburelis)
-
Fix <param> in Help Insight (more higher, simplify) (by Michalis Kamburelis)
-
Snapshots: fix dirs (by Michalis Kamburelis)
-
Simpler pasdoc_snapshot, it is now run by Jenkins (by Michalis Kamburelis)
-
Fix snapshot taking (by Michalis Kamburelis)
-
New /usr/local/fpclazarus/setup.sh location (by Michalis Kamburelis)
-
Better log of snapshots (by Michalis Kamburelis)
-
Setup default FPC for snapshots (by Michalis Kamburelis)
-
Mention in ChangeLog links to enum members (by ...
-
More natural option names for comment markers (...
-
Mention Tipue search improvements (by Michalis ...
-
Load Tipue JS (including tipuesearch_data.js) o...
-
Remove trailing whitespace (by Michalis Kambure...
-
Implement --html-head, --html-body-begin, --htm...
-
Adjust to HTML5: anchors using id=, style <hr> ...
-
Temp directory per-user (by Michalis Kamburelis)
-
Fix packing release (by Michalis Kamburelis)
-
Merge pull request #5 from zekiguven/master (by...
-
Change links michaliskambi/pasdoc -> pasdoc/pas...
-
Change all links, to GitHub wiki / pasdoc.sourc...
-
Rename docs/ to old_docs/, to not confuse. (by ...
-
It seems that chgrp on SF is no longer possible...
-
Shorten and update a bit packages/README.txt (b...
-
delphi xe8 package
-
Thank you! Committed, to source/packages/delphi/XE8/ .
-
Thank you very much, committed! Inside source/packages/delphi/ .
-
delphi xe7 package
-
Added <see cref> tag.
-
Thank you, applied!
