[Lazarus] FPDoc chms and code examples

Sergey Bodrov serbod at gmail.com
Sat Jan 16 11:48:07 CET 2021


Me personally prefer to place short code snippets into help pages, with
some syntax highlight. Also, big code samples can be made as separate help
(html) files, with detailed description. Same as in Wiki.

Pure code examples can be found in lazarus/examples directory, they even
have browser, embedded in IDE (create progect, browse samples).

On Fri, Jan 15, 2021, 10:53 Соболь Андрей Евгеньевич via lazarus <
lazarus at lists.lazarus-ide.org> wrote:

> Hello,
> I see that nobody used to a tag <examples> for creating documentation lcl,
> lazutil. That tag is used only the fpc team.
> I have read a documentation and saw rtl .xml`s and so.
> I want to create a directory for used examples of code as :
>
> - lazarus/doc/exlcl
> - lazarus/doc/exlazutil
>
> and put inside files in notation with dots. For example:
> fileutil.findallfiles.pas (I think it will be convenient)
>
> + readme.txt (into those directories)
> + wiki descriptions about it.
>
> I have checked it, a html`s works and a chm`s too.
>
> What is yours opinion about it?
> And how to create directory, also by patch?
>
> Andrey Sobol.
>
>
> --
> Это сообщение было проверено AVG на наличие вирусов.
> http://www.avg.com
>
> --
> _______________________________________________
> lazarus mailing list
> lazarus at lists.lazarus-ide.org
> https://lists.lazarus-ide.org/listinfo/lazarus
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lazarus-ide.org/pipermail/lazarus/attachments/20210116/6fe0b3a4/attachment-0001.html>


More information about the lazarus mailing list