Re: [cssed-devel] Changed accelerator in Document
Brought to you by:
iagorubio
From: Iago R. <iag...@hi...> - 2005-02-19 18:53:42
|
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 |