[fpc-pascal] fpdoc and three packages
Hi, I have 3 packages using fpdoc documentation in the tiOPF project. Core, Options and GUI. I generate the html help as shown below. I have 2 problems... 1) The index.html file gets overwritten with the last package when the html help is generate, so I don't have a index page for the first two packages. How can I get the three packages to merge there index.html pages, or do I have to create it manually and then have the 3 packages as a sub-directory of that. eg: /html index.html -- manually create listing three packages /core index.html-- auto generated by fpdoc /options index.html-- auto generated by fpdoc /gui index.html-- auto generated by fpdoc 2) How do I reference one package docs from another. For example I have a abstract class in Core and in Options is all the descendants. I want to create a See Also list in Core's documentation so the user can see the concrete class documentation in Options package. Also creating sub-directories as mentioned in (1), wouldn't that cause problems linking two or more packages docs? [...sorry for the text wrapping...] fpdoc --format=html --package=tiOPF2Core --output=html/ \ --input='-Fi../Source/Core ../Source/Core/tiConstants.pas' --descr=xml/core/ticonstants.xml \ --input='-Fi../Source/Core ../Source/Core/tiBaseObject.pas' --descr=xml/core/tibaseobject.xml \ --input='-Fi../Source/Core ../Source/Core/tiVisitor.pas' --descr=xml/core/tivisitor.xml \ fpdoc --format=html --package=tiOPF2Options --output=html/ \ -- Graeme Geldenhuys Location: S 34° 03.168' E018° 49.342' http://tinyurl.com/y6lc26 There's no place like 127.0.0.1 ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
On Wed, 29 Nov 2006, Graeme Geldenhuys wrote: Hi, I have 3 packages using fpdoc documentation in the tiOPF project. Core, Options and GUI. I generate the html help as shown below. I have 2 problems... 1) The index.html file gets overwritten with the last package when the html help is generate, so I don't have a index page for the first two packages. How can I get the three packages to merge there index.html pages, or do I have to create it manually and then have the 3 packages as a sub-directory of that. eg: /html index.html -- manually create listing three packages /core index.html-- auto generated by fpdoc /options index.html-- auto generated by fpdoc /gui index.html-- auto generated by fpdoc You'll have to do it like this. 2) How do I reference one package docs from another. For example I have a abstract class in Core and in Options is all the descendants. I want to create a See Also list in Core's documentation so the user can see the concrete class documentation in Options package. Also creating sub-directories as mentioned in (1), wouldn't that cause problems linking two or more packages docs? Normally not. You should 1. Generate a .toc file (explained in the docs) 2. Reference a something in another package using #packagename.unit.identifier 3. Import the .toc file for the packages you refer to when generating docs for step 2. Do not move the .toc file, as it's location is used to determine the .html files. Michael. ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
Thanks Michael! G. On 11/29/06, Michael Van Canneyt [EMAIL PROTECTED] wrote: Normally not. You should 1. Generate a .toc file (explained in the docs) 2. Reference a something in another package using #packagename.unit.identifier 3. Import the .toc file for the packages you refer to when generating docs for step 2. Do not move the .toc file, as it's location is used to determine the .html files. Michael. -- Graeme Geldenhuys Location: S 34° 03.168' E018° 49.342' http://tinyurl.com/y6lc26 There's no place like 127.0.0.1 ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
Hi Graeme - sorry to be slightly off topic, but is tiOPF working with FPC now? ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
Yes, for a year now... Been using it in a commercial application since January. Graeme. On 11/29/06, Matt Emson [EMAIL PROTECTED] wrote: Hi Graeme - sorry to be slightly off topic, but is tiOPF working with FPC now? ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal -- Graeme Geldenhuys Location: S 34° 03.168' E018° 49.342' http://tinyurl.com/y6lc26 There's no place like 127.0.0.1 ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
Yes, for a year now... Been using it in a commercial application since January. Cool.. and it works with Lazarus? I looked at tiOPF, but went with instant objects becauuse it had better Delphi 5 support. tiOPF is cross platform too? M ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
On 11/29/06, Matt Emson [EMAIL PROTECTED] wrote: Cool.. and it works with Lazarus? I looked at tiOPF, but went with instant objects because it had better Delphi 5 support. Delphi 5 support has been removed in tiOPF version 2, but version 1 is still available on request. Anybody still using tiOPF v1 is highly recommended to upgrade to tiOPF v2. And yes it works under Lazarus, but I guess that depends on what you mean by that. :-) If you mean the tiOPF GUI components, then Boguslaw Brandys would be the best person to speak to, but I think he has ported most of the components. I took a different route mainly because I used Kylix and CLX before FPC, so don't use the tiOPF's GUI controls. I use the Model-GUI-Mediator (MGM) pattern, to make any standard GUI control Object Aware. MGM is a combination of the Observer and Mediator design patterns. tiOPF is cross platform too? Yes, tiOPF is standard Object Pascal code. I use tiOPF under Linux and Windows for all my projects. -- Graeme Geldenhuys Location: S 34° 03.168' E018° 49.342' http://tinyurl.com/y6lc26 There's no place like 127.0.0.1 ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
Delphi 5 support has been removed in tiOPF version 2, but version 1 is still available on request. Anybody still using tiOPF v1 is highly recommended to upgrade to tiOPF v2. No, I used v1. I looked at how much work a backport to D5 would be. Mostly it was routines missing from the Delphi RTL until you got into the whole RTTI debarcle. Needless to say I gave up. I use the Model-GUI-Mediator (MGM) pattern, to make any standard GUI control Object Aware. MGM is a combination of the Observer and Mediator design patterns. Never used that patter but have used those patterns to achieve the same result. However, it's pnly viable for new projects, and those are not generally in Delphi here anymore. Useful for my own work though I guess. If you've never looked at Instant Objects it is worthwhile. Far, far simpler to get in to than tiOPF. Only Win32 though AFAIAA. Yes, tiOPF is standard Object Pascal code. I use tiOPF under Linux and Windows for all my projects. Very useful to know. Thank you! ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] fpdoc and three packages
Matt Emson wrote: If you've never looked at Instant Objects it is worthwhile. Far, far simpler to get in to than tiOPF. Only Win32 though AFAIAA. And Kylix. -- Joao Morais ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
