cssed-devel

[cssed-devel] Changed accelerator in Document

[<mic...@ea...>]

I've changed accelerator in Document/highlighting for Plain text to 
avoid chocking with C/CPP accelerator.
I've also integrated comments in header for plugindoc, to avoid 
reinvent the wheel. Some functions are not documented at the time 
being.

Committed.

Re: [cssed-devel] Changed accelerator in Document

[Iago R. <iag...@hi...>]

On Fri, 2005-02-18 at 18:41, Mich=C3=A8le Garoche wrote:
> I've changed accelerator in Document/highlighting for Plain text to=20
> avoid chocking with C/CPP accelerator.

Ok, thanks.

> I've also integrated comments in header for plugindoc, to avoid=20
> reinvent the wheel.=20

I didn't do it because the plugin's headers are not meant to be exactly
the same as the application headers.

Some functions are taken out for convenience, because are not ready to
be public, and expose internall functions not needed for plugin's
development.

That's why there's a separated set of headers distributed in the include
directory for external developers. Are not exactly the same - or better,
are not meant to be the same - as the internally used ones.

Of course the functions that appears in the plugin's headers are exactly
the same on the application's headers.

> Some functions are not documented at the time

Yes, because I did not documented the code.=20

May be I should start to do it, but right now functions that are not
"public" are not documented.=20

The documentation is for the plugins, not for the applications
developer's docs - that does not exists at the moment.

I was waiting to a have a cleaner code to document it.=20
--=20
Iago Rubio  =20
- Home page    * http://www.iagorubio.com=20
- Last project * http://cssed.sourceforge.net        =20
- GPG Keyserv  * pgp.rediris.es id=3D0x909BD4DD

Re: [cssed-devel] Changed accelerator in Document

[<mic...@ea...>]

Le 19 f=E9vr. 2005, =E0 12:45, Iago Rubio a =E9crit :

> On Fri, 2005-02-18 at 18:41, Mich=E8le Garoche wrote:
>> I've also integrated comments in header for plugindoc, to avoid
>> reinvent the wheel.
>
> I didn't do it because the plugin's headers are not meant to be =
exactly
> the same as the application headers.
>
> Some functions are taken out for convenience, because are not ready to
> be public, and expose internall functions not needed for plugin's
> development.
>
> That's why there's a separated set of headers distributed in the=20
> include
> directory for external developers. Are not exactly the same - or=20
> better,
> are not meant to be the same - as the internally used ones.
>
> Of course the functions that appears in the plugin's headers are=20
> exactly
> the same on the application's headers.
The doxygen file hides those internal functions, so that should be not=20=

a problem, or maybe I don't understand exactly what you mean.

Mich=E8le
<http://micmacfr.homeunix.org>

Re: [cssed-devel] Changed accelerator in Document

[Iago R. <iag...@hi...>]

On Sat, 2005-02-19 at 12:49, Mich=C3=A8le Garoche wrote:
> The doxygen file hides those internal functions, so that should be not=20
> a problem, or maybe I don't understand exactly what you mean.

It's not a problem Michelle, not at all.

What I meant was, some publicly exposed functions in some of the headers
located in src, are not meant to be plugin functions, so we cannot
generate the documentation with the cssed headers - those located in
"cssed/src" - but with the plugin's headers - those located in
"include".

If we generate the plugins docs with the cssed headers some public=20
functions - that I don't want to expose to plugins - will be shown so
used.

That's why I did not documented all the functions on the headers at
"cssed/src" but those at "cssed/include".

Regards.
--=20
Iago Rubio  =20
- Home page    * http://www.iagorubio.com=20
- Last project * http://cssed.sourceforge.net        =20
- GPG Keyserv  * pgp.rediris.es id=3D0x909BD4DD

Re: [cssed-devel] Changed accelerator in Document

[<mic...@ea...>]

Le 19 f=E9vr. 2005, =E0 18:33, Iago Rubio a =E9crit :

> On Sat, 2005-02-19 at 12:49, Mich=E8le Garoche wrote:
>> The doxygen file hides those internal functions, so that should be =
not
>> a problem, or maybe I don't understand exactly what you mean.
>
> It's not a problem Michelle, not at all.
>
> What I meant was, some publicly exposed functions in some of the=20
> headers
> located in src, are not meant to be plugin functions, so we cannot
> generate the documentation with the cssed headers - those located in
> "cssed/src" -
>  but with the plugin's headers - those located in
> "include".
Sure, I have not put all the headers in cssed/src; just the ones used=20
in plugins, that is:
cssdialogs-class.h
cssedwindow.h
document.h
plugin.h
SciLexer.h
Scintilla.h
ScintillaWidget.h

That is correct, is not it?

Then the SciLexer and Scintilla headers do not need documentation at=20
all.
There are only some functions in the other headers which are not=20
commented.

> That's why I did not documented all the functions on the headers at
> "cssed/src" but those at "cssed/include".
I spoke about those of course, sorry for the misunderstanding.

You can see what it becomes here - a work in progress (I've slightly=20
changed the doxyfile to show all functions, even if not documented).
<http://micmacfr.homeunix.org/cssed/html/index.html>

Mich=E8le
<http://micmacfr.homeunix.org>

Re: [cssed-devel] Changed accelerator in Document

[Iago R. <iag...@hi...>]

On Sat, 2005-02-19 at 18:50, Mich=C3=A8le Garoche wrote:
> Le 19 f=C3=A9vr. 2005, =C3=A0 18:33, Iago Rubio a =C3=A9crit :
>=20
> > On Sat, 2005-02-19 at 12:49, Mich=C3=A8le Garoche wrote:
> >> The doxygen file hides those internal functions, so that should be not
> >> a problem, or maybe I don't understand exactly what you mean.
> >
> > It's not a problem Michelle, not at all.
> >
> > What I meant was, some publicly exposed functions in some of the=20
> > headers
> > located in src, are not meant to be plugin functions, so we cannot
> > generate the documentation with the cssed headers - those located in
> > "cssed/src" -
> >  but with the plugin's headers - those located in
> > "include".
> Sure, I have not put all the headers in cssed/src; just the ones used=20
> in plugins, that is:
> cssdialogs-class.h
> cssedwindow.h
> document.h
> plugin.h
> SciLexer.h
> Scintilla.h
> ScintillaWidget.h
>=20
> That is correct, is not it?

Yes, it's correct to start documenting the code, but will not help with
he plugin's doc - that's what I tried to tell you in the previous three
messages :)

> Then the SciLexer and Scintilla headers do not need documentation at=20
> all.

Only one function needed to manage scintilla scintilla_send_message()

> There are only some functions in the other headers which are not=20
> commented.
>=20
> > That's why I did not documented all the functions on the headers at
> > "cssed/src" but those at "cssed/include".
> I spoke about those of course, sorry for the misunderstanding.
>=20
> You can see what it becomes here - a work in progress (I've slightly=20
> changed the doxyfile to show all functions, even if not documented).
> <http://micmacfr.homeunix.org/cssed/html/index.html>

It's a nice start point for the main code documentation, but the code is
still a bit messy to be documented.=20

I'm also going for major changes ...
--=20
Iago Rubio  =20
- Home page    * http://www.iagorubio.com=20
- Last project * http://cssed.sourceforge.net        =20
- GPG Keyserv  * pgp.rediris.es id=3D0x909BD4DD

Re: [cssed-devel] Changed accelerator in Document

[<mic...@ea...>]

Le 19 f=E9vr. 2005, =E0 19:53, Iago Rubio a =E9crit :

> On Sat, 2005-02-19 at 18:50, Mich=E8le Garoche wrote:
>> Le 19 f=E9vr. 2005, =E0 18:33, Iago Rubio a =E9crit :
>>
>>> On Sat, 2005-02-19 at 12:49, Mich=E8le Garoche wrote:
>>>> The doxygen file hides those internal functions, so that should be=20=

>>>> not
>>>> a problem, or maybe I don't understand exactly what you mean.
>>>
>>> It's not a problem Michelle, not at all.
>>>
>>> What I meant was, some publicly exposed functions in some of the
>>> headers
>>> located in src, are not meant to be plugin functions, so we cannot
>>> generate the documentation with the cssed headers - those located in
>>> "cssed/src" -
>>>  but with the plugin's headers - those located in
>>> "include".
>> Sure, I have not put all the headers in cssed/src; just the ones used
>> in plugins, that is:
>> cssdialogs-class.h
>> cssedwindow.h
>> document.h
>> plugin.h
>> SciLexer.h
>> Scintilla.h
>> ScintillaWidget.h
>>
>> That is correct, is not it?
>
> Yes, it's correct to start documenting the code, but will not help =
with
> he plugin's doc - that's what I tried to tell you in the previous =
three
> messages :)
Oh, sorry, I did not want to touch src, hiding in the corner.

It can be left as is for the future when doc will be done for sources.

Mich=E8le
<http://micmacfr.homeunix.org>

Re: [cssed-devel] Changed accelerator in Document

[Iago R. <iag...@hi...>]

On Sat, 2005-02-19 at 20:03, Mich=C3=A8le Garoche wrote:
> >> That is correct, is not it?
> >
> > Yes, it's correct to start documenting the code, but will not help with
> > he plugin's doc - that's what I tried to tell you in the previous three
> > messages :)
> Oh, sorry, I did not want to touch src, hiding in the corner.

Don't worry, no problem at all :)

> It can be left as is for the future when doc will be done for sources.

Yes, indeed will be left there, so I will continue documenting the code
meanwhile I work in the current changes.

It can even help to find possible changes.
--=20
Iago Rubio  =20
- Home page    * http://www.iagorubio.com=20
- Last project * http://cssed.sourceforge.net        =20
- GPG Keyserv  * pgp.rediris.es id=3D0x909BD4DD

Re: [cssed-devel] Changed accelerator in Document

[<mic...@ea...>]

Le 19 f=E9vr. 2005, =E0 20:27, Iago Rubio a =E9crit :

> On Sat, 2005-02-19 at 20:03, Mich=E8le Garoche wrote:
>>>> That is correct, is not it?
>>>
>>> Yes, it's correct to start documenting the code, but will not help=20=

>>> with
>>> he plugin's doc - that's what I tried to tell you in the previous=20
>>> three
>>> messages :)
>> Oh, sorry, I did not want to touch src, hiding in the corner.
>
> Don't worry, no problem at all :)
>
>> It can be left as is for the future when doc will be done for =
sources.
>
> Yes, indeed will be left there, so I will continue documenting the =
code
> meanwhile I work in the current changes.
>
> It can even help to find possible changes.
There is a problem though, because the headers in include are wrong:=20
for example it lacks of some enums (Makefile , etc.)

Mich=E8le
<http://micmacfr.homeunix.org>

Re: [cssed-devel] Changed accelerator in Document

[<mic...@ea...>]

Corrected now with the right headers.

>> <http://micmacfr.homeunix.org/cssed/html/index.html>
>

Mich=E8le
<http://micmacfr.homeunix.org>