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@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@lists.lazarus-ide.org
> https://lists.lazarus-ide.org/listinfo/lazarus
>
-- 
_______________________________________________
lazarus mailing list
lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus
  • [Lazarus] FPDoc... Michael Van Canneyt via lazarus
    • Re: [Lazar... Соболь Андрей Евгеньевич via lazarus
    • Re: [Lazar... Graeme Geldenhuys via lazarus
    • Re: [Lazar... Graeme Geldenhuys via lazarus
      • Re: [L... Michael Van Canneyt via lazarus
      • [Lazar... Соболь Андрей Евгеньевич via lazarus
        • Re... Sergey Bodrov via lazarus
          • ... Andrey Sobol via lazarus
        • Re... Graeme Geldenhuys via lazarus
    • Re: [Lazar... Don Siders via lazarus
      • Re: [L... Michael Van Canneyt via lazarus
        • Re... Don Siders via lazarus
          • ... Michael Van Canneyt via lazarus
      • Re: [L... Graeme Geldenhuys via lazarus
        • Re... Michael Van Canneyt via lazarus
          • ... Graeme Geldenhuys via lazarus
          • ... Santiago A. via lazarus

Reply via email to