--- Leif W <[EMAIL PROTECTED]> wrote:
> Hey,
>
> This thought just occured to me since I'm working on
> the server side stuff at
> the moment. What about the documentation there?
> For example, the client side
> docs for IOElement look pretty complete, but there's
> no server-side docs, just
>
Hey,
This thought just occured to me since I'm working on the server side stuff at
the moment. What about the documentation there? For example, the client side
docs for IOElement look pretty complete, but there's no server-side docs, just
source code with sparse documentation. But in the dialog
[Dynapi-Dev] Documentation Stratagy for DynApi; is there one??
Following comment to the suggestion of using
'jsdoc' as documentation tool:
'jsdoc' is an half dad 2year old project!
An eary beta staged SW with only a minimum on
functionallity and hardly any doc.
And look
[Dynapi-Dev] Documentation Stratagy for DynApi; is there one??
Following comment to the suggestion of using
'jsdoc' as documentation tool:
'jsdoc' is an half dad 2year old project!
An eary beta staged SW with only a minimum on
functionallity and hardly any doc.
And look
--- Dan Willemsen <[EMAIL PROTECTED]> wrote:
>
> Quoting Darin Kadrioski
> <[EMAIL PROTECTED]>:
>
> > http://sourceforge.net/projects/jsdoc/
>
> nice... the only question i have is whether it will
> parse some of the javascript
> that we use in dynapi, some of it isn't all so
> well-formed acco
this is the type of thing I have been planning to do to generate the quickref
documentation, but haven't been able to yet. I just found phpDocumentor
yesterday, and was thinking about writing another parser for it, javascript, but
that looks like to much work for me.
--
Dan Willemsen
http://dan.wi
Quoting Darin Kadrioski <[EMAIL PROTECTED]>:
> http://sourceforge.net/projects/jsdoc/
nice... the only question i have is whether it will parse some of the javascript
that we use in dynapi, some of it isn't all so well-formed according to it's
definition i don't think
--
Dan Willemsen
--
> Behalf Of
> [EMAIL PROTECTED]
> Sent: Thursday, June 26, 2003 4:36 PM
> To: [EMAIL PROTECTED]
> Subject: [Dynapi-Dev] Documentation Stratagy for
> DynApi; is there one??
>
>
> Documentation Stratagy for DynApi; is there one??
> =
>
I like the following layout..
Name Object etc
Syntax
object.method and so on...
Collections and etc.
Methods
Events
Remarks
Howto... and issues
Example
code...
Just my tip of the coin :)
/Daniel
> Documentation Stratagy for DynApi; is there one??
> =
>
>
http://sourceforge.net/projects/jsdoc/
-Original Message-
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED] Behalf Of
[EMAIL PROTECTED]
Sent: Thursday, June 26, 2003 4:36 PM
To: [EMAIL PROTECTED]
Subject: [Dynapi-Dev] Documentation Stratagy for DynApi; is there one??
Documentation
Documentation Stratagy for DynApi; is there one??
=
How do *you* plan to document DynApi code?
I had the problem that I needed inline documentation for my javascripts
(like javadoc for java and phpDocumentor for PHP).
E.g.
/**
* Follwing is a short description.
*
Have you looked at docs/index.html? I've started a
quick reference section that gives some information
about the libraries. That I think is a good place to
start. We could also update documentation the same way
we not do the library files.
PS. I think Juho is also doing some work on the docs,
so
Hello,
I'm wondering if anyone is doing documentation right now for the new
DynAPI 2.9.2. I'm looking into doing some(or a lot, depends), mostly to
get myself more aquanted to the new API, etc. The question is will I be
duplicating anyone's work? The other question is there anyone that is
accep
my 2 cents
Christopher Strolia-Davis
-Original Message-
From: Laszlo Teglas [mailto:[EMAIL PROTECTED]]
Sent: Wednesday, November 28, 2001 10:14 AM
To: Dynapi-Dev@lists. sourceforge. net
Subject: RE: [Dynapi-Dev] Documentation structure candidate (was Dan's
widget discussion)
...
B
@lists. sourceforge. net
Subject: Re: [Dynapi-Dev] Documentation structure candidate (was Dan's
widget discussion)
Hi
Ok Laszlo, a few comments on the documentation proposal:
The basic layout scheme seems good. I guess some of the parts will change as
they are filled in, but this offers an id
Hi
Ok Laszlo, a few comments on the documentation proposal:
The basic layout scheme seems good. I guess some of the parts will change as
they are filled in, but this offers an idea of what still needs to be done.
I'm not so keen on the color choices, I can not really read the red on
orange text,
>You may have misunderstood my post.
Yes, I did. My apologies =;^)
>so the question is, is documentation that looks like this:
> http://www.your-site.com/~rinfo//examples/apiNew/dynapi_8js.html
>In a usable format or not. (Bear in mind that I tried every available
>command, so the output is not p
and
I'll get on with other things in the meantime.
Cheers,
Richard.
- Original Message -
From: "Laszlo Teglas" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Wednesday, November 21, 2001 5:01 PM
Subject: RE: [Dynapi-Dev] documentation
> >I presume it&#
PROTECTED]
Subject: RE: [Dynapi-Dev] documentation
Totally agree with you. two versions is one too much to maintain
and since DynAPI requires some Javascript-knowledge it shouldn't
be too hard to understand the Doxygen-generated docs.
we could extend the documentation with own keywords, not y
line with *
to clearly specify whats comments and whats not.
/martin
> -Original Message-
> From: [EMAIL PROTECTED]
> [mailto:[EMAIL PROTECTED]] On Behalf Of
> Richard Bennett
> Sent: den 21 november 2001 15:29
> To: [EMAIL PROTECTED]
> Subject: [Dynapi-Dev] doc
CTED]
[mailto:[EMAIL PROTECTED]]On Behalf Of Richard
Bennett
Sent: November 21, 2001 9:29 AM
To: [EMAIL PROTECTED]
Subject: [Dynapi-Dev] documentation
hi,
I presume it's a little quite around the documentation topic because
everyone's busy writing the docs :o)
I did some testing on Dox
Keep on doing the rest of the documentation this way. It's perfect! :)
__
Do You Yahoo!?
Yahoo! GeoCities - quick and easy web site hosting, just $8.95/month.
http://geocities.yahoo.com/ps/info1
___
Dynap
wow, I'm impressed.
___
Dynapi-Dev mailing list
[EMAIL PROTECTED]
http://www.mail-archive.com/[email protected]/
hi,
I presume it's a little quite around the documentation topic because
everyone's busy writing the docs :o)
I did some testing on Doxygen.
I don't think it's feasible to update two versions of our source-code, and
to be honest, the docs generated from the Java version of our source code
did not
myLoadPanel.setURL(fileNames[intPageIndex]);
}
ta-da.
- Original Message -
From:
Laszlo Teglas
To: Doug Melvin
Sent: Thursday, November 15, 2001 5:43
PM
Subject: RE: [Dynapi-Dev] Documentation
Project
Have
you done this before? Can a widget access files after
t; To: [EMAIL PROTECTED]
> Subject: Re[6]: [Dynapi-Dev] Documentation Project
> As far as I know, there isn't a way another way. Doxygen doesn't
> recognize JavaScript. I also do not know of any tool that works with
> JavaScript to create documentation. Its a pain to set it up, but
Rainwater
Sent: November 16, 2001 11:30 AM
To: [EMAIL PROTECTED]
Subject: Re[6]: [Dynapi-Dev] Documentation Project
As far as I know, there isn't a way another way. Doxygen doesn't
recognize JavaScript. I also do not know of any tool that works with
JavaScript to create documentation. Its
gt; Does this mean we have to have a set of dummy java classes to mirror our
> dynAPI?
> -Original Message-
> From: [EMAIL PROTECTED]
> [mailto:[EMAIL PROTECTED]]On Behalf Of Robert
> Rainwater
> Sent: November 16, 2001 11:16 AM
> To: [EMAIL PROTECTED]
> Subject: Re[4
Does this mean we have to have a set of dummy java classes to mirror our
dynAPI?
-Original Message-
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]]On Behalf Of Robert
Rainwater
Sent: November 16, 2001 11:16 AM
To: [EMAIL PROTECTED]
Subject: Re[4]: [Dynapi-Dev] Documentation Project
es,
> and tutorial sections by hand.
> -Original Message-
> From: [EMAIL PROTECTED]
> [mailto:[EMAIL PROTECTED]]On Behalf Of Matt Fair
> Sent: November 16, 2001 10:42 AM
> To: [EMAIL PROTECTED]
> Cc: [EMAIL PROTECTED]
> Subject: Re: Re[2]: [Dynapi-Dev] Documentation Proj
still have to do the intro, examples,
and tutorial sections by hand.
-Original Message-
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]]On Behalf Of Matt Fair
Sent: November 16, 2001 10:42 AM
To: [EMAIL PROTECTED]
Cc: [EMAIL PROTECTED]
Subject: Re: Re[2]: [Dynapi-Dev] Documentation Project
uot;,
> > Details:"The dynLayer library. . .",
> > Example:"http://www.richardinfo.com/examples/php/examples.html";,
> > SubData:
>
>
> > -Original Message-
> > From: [EMAIL PROTECTED]
> > [mailto:[EMAIL PROTECTED]
L PROTECTED]]On Behalf Of Richard Bennett
> Sent: November 15, 2001 7:02 PM
> To: Laszlo Teglas; [EMAIL PROTECTED]
> Subject: Re: [Dynapi-Dev] Documentation Project
> Our content should simply be on separate XHTML pages, which can then
> either be loaded into a frame-set, or
lf Of Richard
BennettSent: November 15, 2001 7:02 PMTo: Laszlo Teglas;
[EMAIL PROTECTED]Subject: Re: [Dynapi-Dev]
Documentation Project
Our content should simply be on separate XHTML pages, which
can then either be loaded into a frame-set, or into a dynapi page using
loadpanel.
--
Example: "http://...",
SubData[]
}
]
}
-Original Message-From: Laszlo Teglas
[mailto:[EMAIL PROTECTED]]Sent: Thursday, November
15, 2001 5:12 PMTo:
[EMAIL PROTECTED]Subject: RE: [Dynapi-Dev]
Documentation Project
I
[EMAIL PROTECTED]]On Behalf Of
Strolia-Davis Christopher Contr MSG MAMSent: November 15, 2001
4:24 PMTo: 'Laszlo Teglas';
[EMAIL PROTECTED]Subject: RE: [Dynapi-Dev]
Documentation Project
You
could just have all the information in a data file, and create a widget in
Dy
loadpanel and a multi-dimentional array of
file names...
- Original Message -
From:
Laszlo Teglas
To: [EMAIL PROTECTED]
Sent: Thursday, November 15, 2001 5:12
PM
Subject: RE: [Dynapi-Dev] Documentation
Project
I
like the idea.
Lets
look at the
TECTED]]On Behalf Of
Strolia-Davis Christopher Contr MSG MAMSent: November 15, 2001
4:24 PMTo: 'Laszlo Teglas';
[EMAIL PROTECTED]Subject: RE: [Dynapi-Dev]
Documentation Project
You
could just have all the information in a data file, and create a widget in
DynApi to display it.
ify the current steps once
we settle on this new doc structure.
NanoFace =;^)
-Original Message-
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]]On Behalf Of Richard
Bennett
Sent: November 15, 2001 12:58 PM
To: martin ström; [EMAIL PROTECTED]
Subject: Re: [Dynapi-Dev] Documentation Proje
t; <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Thursday, November 15, 2001 6:32 PM
Subject: RE: [Dynapi-Dev] Documentation Project
> > 1) We could either setup two directories under the CVS (src
> > for commented
> > and js for uncommented) and be forced to strip out t
> 1) We could either setup two directories under the CVS (src
> for commented
> and js for uncommented) and be forced to strip out the
> comments every time
> we make a CVS update.
>
> or my preferred way:
> 2) We could maintain just the src CVS folder fully commented
> and strip out
> the com
-Dev]
Documentation Project
frames? FRAMES?!
Um, this a DHTML library, why not
use Layers..?
- Original Message -
From:
Laszlo Teglas
To: [EMAIL PROTECTED]
Sent: Wednesday, November 14, 2001 5:29
PM
Subject: RE: [Dynapi-Dev] Documentation
AM
To: Doug Melvin; [EMAIL PROTECTED]
Subject: Re: [Dynapi-Dev] Documentation Project
I think we can scrap full XML, as server-side parsing is a pain.. (if we
want the docs to function offline)
I think frames are the easiest solution - no browser problems, no script,
and the pages are reusable
doxygen/index.html.
>>
>>
>> Cheers,
>> Richard.
>>
>>
>>
>>
>>
>> - Original Message -
>> From: "Laszlo Teglas" <[EMAIL PROTECTED]>
>> To: <[EMAIL PROTECTED]>
>> Sent: Wednesday, November 14, 2001 11:41 PM
>
>Dan made a Perl comment-stripper, that would run online, there were still
>some bugs though.
>And Thomas Loo made a script one, very cool called ESC, I'm not sure where
>it is online, his email was:
>[EMAIL PROTECTED]
>This is exactly why we are ending all lines with semi-colons in the script.
I
To: [EMAIL PROTECTED]
Subject: Re: [Dynapi-Dev] Documentation Project
Question: When we talk about using XML or XHTML.. are we talking
server-side?
I certainly hope so seeing as how NS4.x does ont have an XML parser..
I will not agree to forcing someone to download a plugin just to rea
- Original Message -
From: "Doug Melvin" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Thursday, November 15, 2001 3:46 PM
Subject: Re: [Dynapi-Dev] Documentation Project
> What's the benifit then?
>
>
> > When I talk about using XHTML, I a
-Original Message-
From: Laszlo Teglas [mailto:[EMAIL PROTECTED]]
Sent: November 15, 2001 10:03 AM
To: Doug Melvin
Subject: RE: [Dynapi-Dev] Documentation Project
>Whats's the benifit then?
In short, Future compatibility.
XHTML is a stricter version of standard HTML. By comp
-Original Message-
From: Laszlo Teglas [mailto:[EMAIL PROTECTED]]
Sent: November 15, 2001 9:47 AM
To: Doug Melvin
Subject: RE: [Dynapi-Dev] Documentation Project
When I talk about using XHTML, I am talking about using XHTML1.0 strict or
transitional which is the next evolutionary step
ork from the users
> stand point.
> (No plugin required, batteries included) =;^)
>
> -Original Message-
> From: [EMAIL PROTECTED]
> [mailto:[EMAIL PROTECTED]]On Behalf Of Doug Melvin
> Sent: November 15, 2001 9:18 AM
> To: [EMAIL PROTECTED]
> Subject: Re: [Dynapi-De
t; To: [EMAIL PROTECTED]
> Subject: Re: [Dynapi-Dev] Documentation Project
>
>
> If you're going to keep pushing wiki-wiki, maybe you could
> provide a link?
>
>
> > If we do this, we could use Oxygen, this is usable for the whole
> > documentatio
Help is always welcome, in any form..
My question tho, is, who DOES have full admin access to the site?
Anyone? Anyone at all?
- Original Message -
From: "Henrik Våglin" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Wednesday, November 14, 2001 9:08 PM
Su
info.com/examples/Richardinfo_Developer_Docs/
>
> http://www.stack.nl/~dimitri/doxygen/index.html.
>
>
> Cheers,
> Richard.
>
>
>
>
>
> - Original Message -
> From: "Laszlo Teglas" <[EMAIL PROTECTED]>
> To: <[EMAIL PROTECTED]>
> Sent: Wed
> From: "Matt Fair" <[EMAIL PROTECTED]>
> To: "Laszlo Teglas" <[EMAIL PROTECTED]>
> Cc: <[EMAIL PROTECTED]>
> Sent: Wednesday, November 14, 2001 10:39 PM
> Subject: RE: [Dynapi-Dev] Documentation Project
>
>
> > Are we think
frames? FRAMES?!
Um, this a DHTML library, why not
use Layers..?
- Original Message -
From:
Laszlo Teglas
To: [EMAIL PROTECTED]
Sent: Wednesday, November 14, 2001 5:29
PM
Subject: RE: [Dynapi-Dev] Documentation
Project
php
/ asp / cgi / jsp / cfm
EMAIL PROTECTED]>
Cc: <[EMAIL PROTECTED]>
Sent: Wednesday, November 14, 2001 4:39 PM
Subject: RE: [Dynapi-Dev] Documentation Project
> Are we thinking of puting together source documentation like what java
> has with its javadocs?
> A javadoc style would be:
> /**
> I put my d
>tried this, I'm just thinking out loud) I
don't know much about Win2PDF.
>Does it take a graphical snap shot, or does it copy the text of
the document
>and format it into pdf? If it copies the text, does it ignore
HTML tags?
>What would it do to a navsys that is made up of tags mixed wi
Question: When we talk about using XML or XHTML.. are we talking
server-side?
I certainly hope so seeing as how NS4.x does ont have an XML parser..
I will not agree to forcing someone to download a plugin just to read our
docs..
___
Dynapi-Dev mailin
o be bound closely. the best documentation is worthless,
if diffucult to use ( and vice versa ).
.jens.
> -Original Message-
> From: [EMAIL PROTECTED]
>[mailto:[EMAIL PROTECTED]]On Behalf Of Michael
>Pemberton
> Sent: November 14, 2001 4:48 PM
> To: [EMAIL PRO
as meant to contain
compressed .js files)
/martin
> -Original Message-
> From: [EMAIL PROTECTED]
> [mailto:[EMAIL PROTECTED]] On Behalf Of
> Richard Bennett
> Sent: den 15 november 2001 00:47
> To: Laszlo Teglas; [EMAIL PROTECTED]
> Subject: Re: [Dynapi-Dev] Docume
Richard Bennett" <[EMAIL PROTECTED]> wrote:
> I think Hendrik Vaglin is still is still adminning the website, so if you
> want to set up a new documentation section, get in touch with him.
>
> Richard.
>
>
To be clear and correct I only co-administrate the main website. I don't have SFTP or
efore they are downloaded. Thus this effects performance
>
> 2) You have to build a doc compiler. This is a project of its own. I don't
> think we have the resources for that.
>
> NanoFace =;^)
>
> -Original Message-
> From: Matt Fair [mailto:[EMAIL PROTECTED]]
>
D]]On Behalf Of Michael
> Pemberton
> Sent: November 14, 2001 4:48 PM
> To: [EMAIL PROTECTED]
> Subject: RE: [Dynapi-Dev] Documentation Project
>
>
> >I vote for Frames =;^)
>
> >Using frames may also help when we want to update different formats o
t
think we have the resources for that.
NanoFace =;^)
-Original Message-
From: Matt Fair [mailto:[EMAIL PROTECTED]]
Sent: November 14, 2001 4:39 PM
To: Laszlo Teglas
Cc: [EMAIL PROTECTED]
Subject: RE: [Dynapi-Dev] Documentation Project
Are we thinking of puting together source documentation
Sent: Wednesday, November 14, 2001 10:39 PM
Subject: RE: [Dynapi-Dev] Documentation Project
> Are we thinking of puting together source documentation like what java
> has with its javadocs?
> A javadoc style would be:
> /**
> I put my documentation here for this metho
[EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]]On Behalf Of Michael
PembertonSent: November 14, 2001 4:48 PMTo:
[EMAIL PROTECTED]Subject: RE: [Dynapi-Dev]
Documentation Project
>I vote for Frames =;^)
>Using frames may also help when we want to update different
format
ebsite, as this is
> a separate system all together.
> I think Hendrik Vaglin is still is still adminning the website, so if you
> want to set up a new documentation section, get in touch with him.
>
> Richard.
>
>
>
> - Original Message -
> From: "Dou
>I vote for Frames =;^)
>Using frames may also help when we want to update different formats of the
>documentation. i.e. pdf files can be set up to list the content files
>consecutively without the need to strip out the navsys from every page. We
>could then replicate the navsys as a table o
?
NanoFace =;^)
-Original Message-
From: Richard Bennett [mailto:[EMAIL PROTECTED]]
Sent: November 14, 2001 2:56 PM
To: Doug Melvin; Laszlo Teglas; [EMAIL PROTECTED]
Subject: Re: [Dynapi-Dev] Documentation Project
The documentation specs look a little complicated, but I guess that's
inevi
TED]>;
<[EMAIL PROTECTED]>
Sent: Wednesday, November 14, 2001 7:37 PM
Subject: Re: [Dynapi-Dev] Documentation Project
> I like the structure, and will adopt it.
> It should be in HTML, but can be in pdf as well..
> search for and download Win2PDF.. this is a virtual
> printer w
>
To: <[EMAIL PROTECTED]>
Sent: Wednesday, November 14, 2001 1:23 PM
Subject: [Dynapi-Dev] Documentation Project
> Yes we are desperately in need of documentation. I believe we should
create
> a document structure instead of just adding files and tutorials
independent
> of
Yes we are desperately in need of documentation. I believe we should create
a document structure instead of just adding files and tutorials independent
of each other. I have started to lay out the documentation structure as I
perceive it to be logical. I am looking for feedback and expanding the
s
Its been updated in CVS. I'm sure more errors as well. Also, I we
need to add the other packages to the documentation. If you get the
config files from cvs you can see how easy it is to document.
--
// Robert Rainwater
On 2/12/2001, 8:42:10 PM EST, robelix wrote about "[
Hi!
in docs/api/class_DynLayer.html it says:
int DynLayer::getClip ( )
Reurns a array of length 4 containing the clip values
[right,left,top,bottom].
the right order is : [top,right,bottom,left]
Roland
___
Dynapi-Dev mailing list
[EMAIL PROTECT
Before I left for vacation I put some of the
documentation that I was working on in CVS. The
documentation is basically the same format as Pascals.
Since I can't work on it for a few weeks (i'm not
even going to try to edit files using my palm pilot),
I was hoping someone could work on the docum
75 matches
Mail list logo
