[prev in list] [next in list] [prev in thread] [next in thread] 

List:       koffice-devel
Subject:    Remaining dox errors in koffice libs
From:       Adriaan de Groot <groot () kde ! org>
Date:       2005-07-22 14:12:52
Message-ID: 200507221612.52628.groot () kde ! org
[Download RAW message or body]

Hiya,

I've been patching up the apidox all over kde (as some of you know), and 
koffice is headed towards a nice set of dox. krita, kexi, kspread are in 
there, and so is the koffice libraries. But there's a few dox errors left 
there that I just _don't_ know how to fix, and that's because I don't 
intimately know the code. The errors are these:

/mnt/src/kde-HEAD/koffice/lib/kotext/koparagcounter.h:74 Warning: The 
following parameters of KoParagCounter::loadOasis(KoOasisContext &context, 
int restartNumbering, bool orderedList, bool heading, int level, bool 
loadingStyle=false) are not documented:
  parameter context
  parameter restartNumbering
  parameter orderedList

/mnt/src/kde-HEAD/koffice/lib/kotext/koparaglayout.h:128 Warning: The 
following parameters of KoParagLayout::saveOasis(KoGenStyle &gs, 
KoSavingContext &context, bool savingStyle) const are not documented:
  parameter gs
  parameter context

/mnt/src/kde-HEAD/koffice/lib/kotext/kotextobject.h:59 Warning: The following 
parameters of KoTextFormatInterface::setFormatCommand(const KoTextFormat 
*format, int flags, bool zoomFont=false) are not documented:
  parameter flags


So it's a case of 6 undocumented parameters in all, across three files. 
Unfortunately, I cannot guess a meaningful description of any of the 
parameters (well, context = the context we're loading into; restartNumbering 
= where to start numbering from again if this is a list; orderedList = true 
if this is an ordered (i.e. numbered) list and false if it's just plain 
bulleted) ... something like that. Parameter "flags" is of course just plain 
voodoo.

Perhaps you, developers, can tell me what these parameters are for, and then 
koffice is another step closer to being "clean".

[ade]


-- 
These are your friends - Adem
    GPG: FEA2 A3FE Adriaan de Groot
_______________________________________________
koffice-devel mailing list
koffice-devel@kde.org
https://mail.kde.org/mailman/listinfo/koffice-devel

[prev in list] [next in list] [prev in thread] [next in thread]