[fpc-devel] fpdoc and fv

[Michael Van Canneyt]

On Sat, 23 Aug 2008, Marco van de Voort wrote:

> In our previous episode, Michael Van Canneyt said:
> > > > 
> > > > Not currently. 
> > > > Someone else generates the pdf classchart from a OpenOffice spreadsheet.
> > > 
> > > And where is that one? Couldn't find it in svn.
> > 
> > It isn't. I get the ready made PDF :-)
> 
> Hmm, that is not an healthy situation.

I know. 

> 
> > > > In general, the idea is to create the classchart from within 
> > > > fpdoc.
> > > 
> > > Yes, an abstract format. However you might get into problems with dividing
> > > it up to nicely fill a page that way.
> > 
> > I know.
> 
> (that also has advantages btw, in a previous job I could print A2 (single
> sheet sideways into an A3 printer), and being able to solve this could be
> nice)
> 
> I suggest for now to at least maintain the classchart.ps, simply because the
> format can easily used as reference for whatever follows.

Yes, but then you'll have A LOT of work, because the .ps is heavily outdated :(

>  
> > > Why XML? It is so human-unreadable, and more a machine format than an
> > > editable one? I like the current ps format much more. OTOH the editor would
> > > be a simple treeview mostly.
> > 
> > XML because it can be easily manipulated.
> 
> Yes, but what you save on the manipulation, you lose on the editing, making
> it nearly mandatory to make and support a gui tool. IMHO for small data
> amounts like this it is not worth it :-)

Small data amounts ? Have you ever counted the number of classes ? :-)

> > > > Should be easy to do. then a tool can be used which converts this
> > > > tree to PostScript or PDF or whatever...
> > > 
> > > See above.
> > 
> > Yes, but postscript is impossible to maintain automated. Hence the
> > inbetween-format.
> 
> Do you have enough info to generate this from sources, and e.g. tell TP,
> Delphi and interface hierarchies apart? Then we only need to add a treeview
> to the gui doc tool so we can add properties there?

I have enough info, yes. What is needed still is the ability to merge 2
trees.
 
> We then have to define a handy set of properties to control formatting, but
> probably we need to see the raw output for that first then.

Yes.

> 
> > > > > model, but some classes are done. 
> > > > > 
> > > > > Before I start debugging, does sb know what that could be?
> > > > 
> > > > Not without the failure message...
> > > 
> > > There was none. It just generated an empty xml for e.g. Views.
> > 
> > 
> > Change to platform.inc and it works fine.
> 
> Solved thanks. Got an awful deja vu feeling there.

I had the same thought :-)

Michael.