Re: Documenting the COM interface for SubWCRev

On 11/06/07, Stefan Küng <tortoisesvn@gmail.com> wrote:
> Simon Large wrote:
> > Hi folks,
> >
> > I could use a little help here as I have never used a COM interface
> > and am fairly vague as to what it might be used for. I certainly don't
> > use them in embedded systems. Apart from pasting Stefan's example
> > script into the docs, I have no clue how to document this feature. If
> > anyone would like to submit a suggestion I will add it in.
>
> A COM interface can be used by almost any programming language. Even
> from scripting languages like vb or javascript. That's why I implemented
> it in SubWCRev.
> I think the documentation about the interface can be kept simple. Just
> mention the COM interface, the object to create and the methods to use.
> You can get the object name and the methods from the example script. And
> of course, include the example script in the docs.

GetWCInfo takes 3 parameters (if that is the correct COM term). The
first is the path to trawl. What are the 2nd and 3rd? I assume they
correspond in some way to the -e and -f switches to the SubWCRev
program.

Your example uses objScript for the file system object and objScript1
etc for the SubWCRev objects. I mis-read this at first and thought
GetAbsolutePathName was a method for SubWCRev. The example would be
clearer if you picked more meaningful object names.

Simon

-- 
       ___
  oo  // \\      "De Chelonian Mobile"
 (_,\/ \_/ \     TortoiseSVN
   \ \_/_\_/>    The coolest Interface to (Sub)Version Control
   /_/   \_\     http://tortoisesvn.net
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tortoisesvn.tigris.org
For additional commands, e-mail: dev-help@tortoisesvn.tigris.org