Giter VIP home page Giter VIP logo

pasdoc.github.io's Introduction

PasDoc

PasDoc is a documentation tool for Pascal and Object Pascal source code. Documentation is generated from comments found in the source code or from external files. Many formatting @-tags are supported. Many output formats are supported, including HTML and LaTeX.

See the documentation on https://pasdoc.github.io/ .

License

GNU GPL 2.

pasdoc.github.io's People

Contributors

michaliskambi avatar

Stargazers

 avatar

Watchers

 avatar  avatar

pasdoc.github.io's Issues

Feature request: Allow documentation in implementation section

Hello,

personally, I like pasdoc much more than fpdoc because having the documentation together with the code imho makes it much easier to keep it up-to-date.

On the other hand, what I don't like is that it's required to put it in the interface section. I think it doesn't belong there because just as the code itself, I consider the documentation an implementation detail. Having it in the interface section makes the whole section very hard to read (because of its length) and hardens programing a lot. So I'm at the same point as with fpdoc again: I don't write any documentation :(

So my request is to allow users to place the documentation together with the code implementation. Ideally, this also should be allowed for simple types like "TMonth = (monJanuary, monFebruary)", but at least for all classes and its methods, properties, etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.