[Libreoffice-commits] .: regexp/inc sd/inc sd/source
Philipp Riemer
priemer at kemper.freedesktop.org
Sun Aug 5 15:20:01 PDT 2012
regexp/inc/regexp/reclass.hxx | 233 ++++++++++-------------
sd/inc/anminfo.hxx | 26 +-
sd/inc/sdpage.hxx | 30 +-
sd/inc/sdpptwrp.hxx | 2
sd/inc/sdxmlwrp.hxx | 6
sd/source/filter/eppt/eppt.hxx | 4
sd/source/filter/eppt/escherex.hxx | 16 -
sd/source/filter/eppt/pptexsoundcollection.hxx | 4
sd/source/filter/html/htmlex.hxx | 10
sd/source/ui/animations/motionpathtag.hxx | 11 -
sd/source/ui/annotations/annotationtag.hxx | 10
sd/source/ui/presenter/CanvasUpdateRequester.hxx | 4
12 files changed, 162 insertions(+), 194 deletions(-)
New commits:
commit 78b55ad11365bb97def308071bc45ca52cc557c7
Author: Norah A. Abanumay <nabanimy at kacst.edu.sa>
Date: Sun Aug 5 13:32:31 2012 +0300
Convert documents to follow the doxygen standard (fdo#44502, fdo#39468)
Change-Id: I58c73f74d53b5dc2eb462fb03664be65d4500170
Reviewed-by: Philipp Riemer <ruderphilipp at gmail.com>
diff --git a/regexp/inc/regexp/reclass.hxx b/regexp/inc/regexp/reclass.hxx
index cc9bf1d..1b1f6d9 100644
--- a/regexp/inc/regexp/reclass.hxx
+++ b/regexp/inc/regexp/reclass.hxx
@@ -45,35 +45,35 @@
typedef enum
{
#ifdef _XOPEN_SOURCE
- REG_ENOSYS = -1, /* This will never happen for this implementation. */
+ REG_ENOSYS = -1, ///< This will never happen for this implementation.
#endif
- REG_NOERROR = 0, /* Success. */
- REG_NOMATCH, /* Didn't find a match (for regexec). */
+ REG_NOERROR = 0, ///< Success.
+ REG_NOMATCH, ///< Didn't find a match (for regexec).
/* POSIX regcomp return error codes. (In the order listed in the
standard.) */
- REG_BADPAT, /* Invalid pattern. */
- REG_ECOLLATE, /* Not implemented. */
- REG_ECTYPE, /* Invalid character class name. */
- REG_EESCAPE, /* Trailing backslash. */
- REG_ESUBREG, /* Invalid back reference. */
- REG_EBRACK, /* Unmatched left bracket. */
- REG_EPAREN, /* Parenthesis imbalance. */
- REG_EBRACE, /* Unmatched \{. */
- REG_BADBR, /* Invalid contents of \{\}. */
- REG_ERANGE, /* Invalid range end. */
- REG_ESPACE, /* Ran out of memory. */
- REG_BADRPT, /* No preceding re for repetition op. */
+ REG_BADPAT, ///< Invalid pattern.
+ REG_ECOLLATE, ///< Not implemented.
+ REG_ECTYPE, ///< Invalid character class name.
+ REG_EESCAPE, ///< Trailing backslash.
+ REG_ESUBREG, ///< Invalid back reference.
+ REG_EBRACK, ///< Unmatched left bracket.
+ REG_EPAREN, ///< Parenthesis imbalance.
+ REG_EBRACE, ///< Unmatched \{.
+ REG_BADBR, ///< Invalid contents of \{\}.
+ REG_ERANGE, ///< Invalid range end.
+ REG_ESPACE, ///< Ran out of memory.
+ REG_BADRPT, ///< No preceding re for repetition op.
/* Error codes we've added. */
- REG_EEND, /* Premature end. */
- REG_ESIZE, /* Compiled pattern bigger than 2^16 bytes. */
- REG_ERPAREN /* Unmatched ) or \); not returned from regcomp. */
+ REG_EEND, ///< Premature end.
+ REG_ESIZE, ///< Compiled pattern bigger than 2^16 bytes.
+ REG_ERPAREN ///< Unmatched ) or \); not returned from regcomp.
} reg_errcode_t;
-/* This data structure represents a compiled pattern. Before calling
+/** This data structure represents a compiled pattern. Before calling
the pattern compiler, the fields `buffer', `allocated', `fastmap',
can be set. After the pattern has been
compiled, the `re_nsub' field is available. All other fields are
@@ -83,44 +83,41 @@ struct REGEXP_DLLPUBLIC re_pattern_buffer
{
/* [[[begin pattern_buffer]]] */
/* Space that holds the compiled pattern. It is declared as
- `unsigned char *' because its elements are
- sometimes used as array indexes. */
+ `unsigned char *' because its elements are
+ sometimes used as array indexes. */
sal_Unicode *buffer;
- /* Number of bytes to which `buffer' points. */
+ /// Number of bytes to which `buffer' points.
sal_uInt32 allocated;
- /* Number of bytes actually used in `buffer'. */
+ /// Number of bytes actually used in `buffer'.
sal_uInt32 used;
- /* Pointer to a fastmap, if any, otherwise zero. re_search uses
- the fastmap, if there is one, to skip over impossible
- starting points for matches. */
+ /** Pointer to a fastmap, if any, otherwise zero. re_search uses the fastmap,
+ if there is one, to skip over impossible starting points for matches. */
sal_Unicode *fastmap;
-
- /* Number of subexpressions found by the compiler. */
+ /// Number of subexpressions found by the compiler.
size_t re_nsub;
- /* Zero if this pattern cannot match the empty string, one else.
- Well, in truth it's used only in `re_search2', to see
- whether or not we should use the fastmap, so we don't set
- this absolutely perfectly; see `re_compile_fastmap' (the
- `duplicate' case). */
+ /** Zero if this pattern cannot match the empty string, one else. Well, in
+ truth it's used only in `re_search2', to see whether or not we should use
+ the fastmap, so we don't set this absolutely perfectly;
+ see `re_compile_fastmap' (the `duplicate' case). */
unsigned can_be_null : 1;
- /* Set to zero when `regex_compile' compiles a pattern; set to one
- by `re_compile_fastmap' if it updates the fastmap. */
+ /** Set to zero when `regex_compile' compiles a pattern; set to one
+ by `re_compile_fastmap' if it updates the fastmap. */
unsigned fastmap_accurate : 1;
- /* If set, a beginning-of-line anchor doesn't match at the
- beginning of the string. */
+ /** If set, a beginning-of-line anchor doesn't
+ match at the beginning of the string. */
unsigned not_bol : 1;
- /* Similarly for an end-of-line anchor. */
+ /// Similarly for an end-of-line anchor.
unsigned not_eol : 1;
- /* If true, an anchor at a newline matches. */
+ /// If true, an anchor at a newline matches.
unsigned newline_anchor : 1;
/* [[[end pattern_buffer]]] */
@@ -135,124 +132,116 @@ typedef enum
{
no_op = 0,
- /* Succeed right away--no more backtracking. */
+ /// Succeed right away -- no more backtracking.
succeed,
- /* Followed by one byte giving n, then by n literal bytes. */
+ /// Followed by one byte giving n, then by n literal bytes.
exactn,
- /* Matches any (more or less) character. */
+ /// Matches any (more or less) character.
anychar,
- /* Matches any one char belonging to specified set. First
- following byte is number of bitmap bytes. Then come bytes
- for a bitmap saying which chars are in. Bits in each byte
- are ordered low-bit-first. A character is in the set if its
- bit is 1. A character too large to have a bit in the map is
- automatically not in the set. */
+ /** Matches any one char belonging to specified set. First following byte is
+ number of bitmap bytes. Then come bytes for a bitmap saying which chars
+ are in. Bits in each byte are ordered low-bit-first. A character is in
+ the set if its bit is 1. A character too large to have a bit in the map
+ is automatically not in the set. */
charset,
- /* Same parameters as charset, but match any character that is
- not one of those specified. */
+ /** Same parameters as charset, but match any character
+ that is not one of those specified. */
charset_not,
- /* Start remembering the text that is matched, for storing in a
- register. Followed by one byte with the register number, in
- the range 0 to one less than the pattern buffer's re_nsub
- field. Then followed by one byte with the number of groups
- inner to this one. (This last has to be part of the
- start_memory only because we need it in the on_failure_jump
- of re_match2.) */
+ /** Start remembering the text that is matched, for storing in a register.
+ Followed by one byte with the register number, in the range 0 to one
+ less than the pattern buffer's re_nsub field. Then followed by one byte
+ with the number of groups inner to this one. (This last has to be part
+ of the start_memory only because we need it in the on_failure_jump of
+ re_match2.) */
start_memory,
- /* Stop remembering the text that is matched and store it in a
- memory register. Followed by one byte with the register
- number, in the range 0 to one less than `re_nsub' in the
- pattern buffer, and one byte with the number of inner groups,
- just like `start_memory'. (We need the number of inner
- groups here because we don't have any easy way of finding the
- corresponding start_memory when we're at a stop_memory.) */
+ /** Stop remembering the text that is matched and store it in a memory
+ register. Followed by one byte with the register number, in the range 0
+ to one less than `re_nsub' in the pattern buffer, and one byte with the
+ number of inner groups, just like `start_memory'. (We need the number of
+ inner groups here because we don't have any easy way of finding the
+ corresponding start_memory when we're at a stop_memory.) */
stop_memory,
- /* Match a duplicate of something remembered. Followed by one
- byte containing the register number. */
+ /** Match a duplicate of something remembered. Followed by one
+ byte containing the register number. */
duplicate,
- /* Fail unless at beginning of line. */
+ /// Fail unless at beginning of line.
begline,
- /* Fail unless at end of line. */
+ /// Fail unless at end of line.
endline,
- /* Succeeds if at beginning of buffer (if emacs) or at beginning
- of string to be matched (if not). */
+ /** Succeeds if at beginning of buffer (if emacs) or
+ at beginning of string to be matched. */
begbuf,
- /* Analogously, for end of buffer/string. */
+ /// Analogously, for end of buffer/string.
endbuf,
- /* Followed by two byte relative address to which to jump. */
+ /// Followed by two byte relative address to which to jump.
jump,
- /* Same as jump, but marks the end of an alternative. */
+ /// Same as jump, but marks the end of an alternative.
jump_past_alt,
- /* Followed by two-byte relative address of place to resume at
- in case of failure. */
+ /** Followed by two-byte relative address of place
+ to resume at in case of failure. */
on_failure_jump,
- /* Like on_failure_jump, but pushes a placeholder instead of the
- current string position when executed. */
+ /** Like on_failure_jump, but pushes a placeholder instead of
+ the current string position when executed. */
on_failure_keep_string_jump,
- /* Throw away latest failure point and then jump to following
- two-byte relative address. */
+ /** Throw away latest failure point and then
+ jump to following two-byte relative address.
pop_failure_jump,
- /* Change to pop_failure_jump if know won't have to backtrack to
- match; otherwise change to jump. This is used to jump
- back to the beginning of a repeat. If what follows this jump
- clearly won't match what the repeat does, such that we can be
- sure that there is no use backtracking out of repetitions
- already matched, then we change it to a pop_failure_jump.
- Followed by two-byte address. */
+ /** Change to pop_failure_jump if know won't have to backtrack to match;
+ otherwise change to jump. This is used to jump back to the beginning of
+ a repeat. If what follows this jump clearly won't match what the repeat
+ does, such that we can be sure that there is no use backtracking out of
+ repetitions already matched, then we change it to a pop_failure_jump.
+ Followed by two-byte address. */
maybe_pop_jump,
- /* Jump to following two-byte address, and push a dummy failure
- point. This failure point will be thrown away if an attempt
- is made to use it for a failure. A `+' construct makes this
- before the first repeat. Also used as an intermediary kind
- of jump when compiling an alternative. */
+ /** Jump to following two-byte address, and push a dummy failure point. This
+ failure point will be thrown away if an attempt is made to use it for a
+ failure. A `+' construct makes this before the first repeat. Also used
+ as an intermediary kind of jump when compiling an alternative. */
dummy_failure_jump,
- /* Push a dummy failure point and continue. Used at the end of
- alternatives. */
+ /// Push a dummy failure point and continue. Used at the end of alternatives.
push_dummy_failure,
- /* Followed by two-byte relative address and two-byte number n.
- After matching N times, jump to the address upon failure. */
+ /** Followed by two-byte relative address and two-byte number n.
+ After matching N times, jump to the address upon failure. */
succeed_n,
- /* Followed by two-byte relative address, and two-byte number n.
- Jump to the address N times, then fail. */
+ /** Followed by two-byte relative address, and two-byte number n.
+ Jump to the address N times, then fail. */
jump_n,
- /* Set the following two-byte relative address to the
- subsequent two-byte number. The address *includes* the two
- bytes of number. */
+ /** Set the following two-byte relative address to the subsequent two-byte
+ number. The address *includes* the two bytes of number. */
set_number_at,
- wordbeg, /* Succeeds if at word beginning. */
- wordend /* Succeeds if at word end. */
-
+ wordbeg, ///< Succeeds if at word beginning.
+ wordend ///< Succeeds if at word end.
} re_opcode_t;
typedef struct re_pattern_buffer regex_t;
-/* Type for byte offsets within the string. POSIX mandates this. */
+/// Type for byte offsets within the string. POSIX mandates this.
typedef sal_Int32 regoff_t;
-/* This is the structure we store register match data in. See
- regex.texinfo for a full description of what registers match. */
+/** This is the structure we store register match data in. See
+ regex.texinfo for a full description of what registers match. */
struct REGEXP_DLLPUBLIC re_registers
{
sal_uInt32 num_regs;
@@ -287,7 +276,7 @@ typedef struct
{
fail_stack_elt_t *stack;
sal_uInt32 size;
- sal_uInt32 avail; /* Offset of next open position. */
+ sal_uInt32 avail; ///< Offset of next open position.
} fail_stack_type;
typedef union
@@ -295,8 +284,8 @@ typedef union
fail_stack_elt_t word;
struct
{
- /* This field is one if this group can match the empty string,
- zero if not. If not yet determined, `MATCH_NULL_UNSET_VALUE'. */
+/* This field is one if this group can match the empty string,
+ zero if not. If not yet determined, `MATCH_NULL_UNSET_VALUE'. */
#define MATCH_NULL_UNSET_VALUE 3
unsigned match_null_string_p : 2;
unsigned is_active : 1;
@@ -311,32 +300,26 @@ class REGEXP_DLLPUBLIC Regexpr
::com::sun::star::uno::Reference<
::com::sun::star::i18n::XExtendedTransliteration > translit;
- const sal_Unicode *line; // line to search in
- sal_Int32 linelen; // length of search string
-
- sal_Unicode *pattern; // RE pattern to match
- sal_Int32 patsize; // Length of pattern
+ const sal_Unicode *line; ///< line to search in.
+ sal_Int32 linelen; ///< length of search string.
+ sal_Unicode *pattern; ///< RE pattern to match.
+ sal_Int32 patsize; ///< Length of pattern.
struct re_pattern_buffer *bufp;
sal_Bool isIgnoreCase;
- /* Either a translate table to apply to all characters before
- comparing them, or zero for no translation. The translation
- is applied to a pattern when it is compiled and to a string
- when it is matched. */
+ /** Either a translate table to apply to all characters before comparing
+ them, or zero for no translation. The translation is applied to a
+ pattern when it is compiled and to a string when it is matched. */
int translate;
sal_uInt32 failure_id;
sal_uInt32 nfailure_points_pushed;
sal_uInt32 nfailure_points_popped;
- /* Counts the total number of registers pushed. */
- sal_uInt32 num_regs_pushed;
-
+ sal_uInt32 num_regs_pushed; ///< Counts the total number of registers pushed.
sal_uInt32 re_max_failures;
-
- /* Registers are set to a sentinel when they haven't yet matched. */
- sal_Unicode reg_unset_dummy;
+ sal_Unicode reg_unset_dummy; ///< Registers are set to a sentinel when they haven't yet matched.
// private instance functions
inline void store_number( sal_Unicode * destination, sal_Int32 number );
@@ -385,7 +368,7 @@ public:
void set_line( const sal_Unicode *line, sal_Int32 len );
- // function returning pointers to occurrences in regs
+ /// @return pointers to occurrences in regs.
sal_Int32 re_search(struct re_registers *regs, sal_Int32 pOffset); // find pattern in line
};
diff --git a/sd/inc/anminfo.hxx b/sd/inc/anminfo.hxx
index 605863b..72f2a96 100644
--- a/sd/inc/anminfo.hxx
+++ b/sd/inc/anminfo.hxx
@@ -37,26 +37,26 @@ public:
PresObjKind mePresObjKind;
/* deprecated animation infos */
- ::com::sun::star::presentation::AnimationEffect meEffect; ///< Animation effect
- ::com::sun::star::presentation::AnimationEffect meTextEffect; ///< Animation effect for text
- ::com::sun::star::presentation::AnimationSpeed meSpeed; ///< Speed of the animation
+ ::com::sun::star::presentation::AnimationEffect meEffect; ///< Animation effect
+ ::com::sun::star::presentation::AnimationEffect meTextEffect; ///< Animation effect for text content
+ ::com::sun::star::presentation::AnimationSpeed meSpeed; ///< Speed of the animation
sal_Bool mbActive; ///< turned on?
- sal_Bool mbDimPrevious; ///< Object Dim
- sal_Bool mbIsMovie; ///< wenn Gruppenobjekt, dann Sequenz aus den
+ sal_Bool mbDimPrevious; ///< Object fade out
+ sal_Bool mbIsMovie; ///< if group object than it is a sequence of them.
sal_Bool mbDimHide; ///< hide rather than dim
Color maBlueScreen; ///< identifies "background pixels"
- Color maDimColor; ///< zum Abblenden des Objekts
+ Color maDimColor; ///< for fading the object
String maSoundFile; ///< Path to the sound file in MS DOS notation
sal_Bool mbSoundOn; ///< Sound on / off
- sal_Bool mbPlayFull; ///< Play sound quite
+ sal_Bool mbPlayFull; ///< play sound completely.
SdrPathObj* mpPathObj; ///< The path object
::com::sun::star::presentation::ClickAction meClickAction; ///< Action at mouse click
- ::com::sun::star::presentation::AnimationEffect meSecondEffect; ///< for Hidden object
- ::com::sun::star::presentation::AnimationSpeed meSecondSpeed; ///< for Hidden object
- String maSecondSoundFile; ///< for Hidden object
- sal_Bool mbSecondSoundOn; ///< for Hidden object
- sal_Bool mbSecondPlayFull;///< ffor Hidden object
- sal_uInt16 mnVerb; ///< for OLE object
+ ::com::sun::star::presentation::AnimationEffect meSecondEffect; ///< for object fading.
+ ::com::sun::star::presentation::AnimationSpeed meSecondSpeed; ///< for object fading.
+ String maSecondSoundFile; ///< for object fading.
+ sal_Bool mbSecondSoundOn; ///< for object fading.
+ sal_Bool mbSecondPlayFull; ///< for object fading.
+ sal_uInt16 mnVerb; ///< for OLE object
sal_uLong mnPresOrder;
SdrObject& mrObject;
diff --git a/sd/inc/sdpage.hxx b/sd/inc/sdpage.hxx
index b6c68bb..9b1236a 100644
--- a/sd/inc/sdpage.hxx
+++ b/sd/inc/sdpage.hxx
@@ -118,28 +118,27 @@ friend class sd::UndoGeoObject;
friend class sd::UndoAttrObject;
protected:
- PageKind mePageKind; ///< page Type
+ PageKind mePageKind; ///< page type
AutoLayout meAutoLayout; ///< AutoLayout
- sd::ShapeList maPresentationShapeList; ///< presentation objects
+ sd::ShapeList maPresentationShapeList;///< presentation objects
sd::ScopeLock maLockAutoLayoutArrangement;
sal_Bool mbSelected; ///< selection identifier
PresChange mePresChange; ///< manual / automatic / semi automatic
sal_uInt32 mnTime; ///< Display time in seconds
- sal_Bool mbSoundOn; ///< with / without sound(sal_True/sal_False)
- sal_Bool mbExcluded; ///< wird in der Show nicht/doch
- ///< displayed (sal_True/sal_False)
+ sal_Bool mbSoundOn; ///< with / without sound.
+ sal_Bool mbExcluded; ///< will (not) be displayed during show.
String maLayoutName; ///< Name of the layout
- String maSoundFile; ///< Path to Sound File (MSDOS-Notation)
+ String maSoundFile; ///< Path to sound file (MSDOS notation).
bool mbLoopSound;
bool mbStopSound;
- String maCreatedPageName; ///< GetPageName generated by Page Name
- String maFileName; ///< Filename
- String maBookmarkName; ///< Bookmarkname
+ String maCreatedPageName; ///< generated page name by GetPageName.
+ String maFileName; ///< file name.
+ String maBookmarkName; ///< Bookmark name.
sal_Bool mbScaleObjects; ///< Objects should be scaled
- sal_Bool mbBackgroundFullSize; ///< Background object to represent the whole page
- rtl_TextEncoding meCharSet; ////< Text-Encoding
+ sal_Bool mbBackgroundFullSize; ///< Background object to represent the whole page.
+ rtl_TextEncoding meCharSet; ///< Text encoding
sal_uInt16 mnPaperBin; ///< PaperBin
- Orientation meOrientation; ///< Print-Orientation
+ Orientation meOrientation; ///< Print orientation.
SdPageLink* mpPageLink; ///< Page link (at left sides only)
sd::AnnotationVector maAnnotations;
@@ -271,7 +270,6 @@ public:
double getTransitionDuration() const;
void setTransitionDuration( double fTranstionDuration );
- /// Virtual methods of SdrObjUserCall.
virtual void Changed(const SdrObject& rObj, SdrUserCallType eType,
const Rectangle& rOldBoundRect);
@@ -320,7 +318,7 @@ public:
/** sets the main animation node */
void setAnimationNode( ::com::sun::star::uno::Reference< ::com::sun::star::animations::XAnimationNode >& xNode ) throw (::com::sun::star::uno::RuntimeException);
- /** @return a helper class to manipulate effects inside the main sequence */
+ /// @return a helper class to manipulate effects inside the main sequence
boost::shared_ptr< sd::MainSequence > getMainSequence();
/** quick check if this slide has an animation node.
@@ -329,7 +327,7 @@ public:
*/
bool hasAnimationNode() const;
- /** @return the SdPage implementation for the given XDrawPage or 0 if not available */
+ /// @return the SdPage implementation for the given XDrawPage or 0 if not available
static SdPage* getImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& xPage );
/** removes all custom animations for the given shape */
@@ -343,9 +341,9 @@ public:
void setHeaderFooterSettings( const sd::HeaderFooterSettings& rNewSettings );
/**
- This method
@return true if the object from the ViewObjectContact should
be visible on this page while rendering.
+
bEdit selects if visibility test is for an editing view or a final render,
like printing.
*/
diff --git a/sd/inc/sdpptwrp.hxx b/sd/inc/sdpptwrp.hxx
index 4b0c424..beb4818 100644
--- a/sd/inc/sdpptwrp.hxx
+++ b/sd/inc/sdpptwrp.hxx
@@ -39,7 +39,7 @@ public:
sal_Bool Import();
sal_Bool Export();
- /// restaures the original basic storage
+ /// restores the original basic storage
void PreSaveBasic();
private:
diff --git a/sd/inc/sdxmlwrp.hxx b/sd/inc/sdxmlwrp.hxx
index 6440d1a..bc5055e 100644
--- a/sd/inc/sdxmlwrp.hxx
+++ b/sd/inc/sdxmlwrp.hxx
@@ -28,9 +28,9 @@
enum SdXMLFilterMode
{
- SDXMLMODE_Normal, /// standard load and save of the complete document
- SDXMLMODE_Preview, /// only for import, only the first draw page and its master page is loaded
- SDXMLMODE_Organizer /// only for import, only the styles are loaded
+ SDXMLMODE_Normal, ///< standard load and save of the complete document
+ SDXMLMODE_Preview, ///< only for import, only the first draw page and its master page is loaded
+ SDXMLMODE_Organizer ///< only for import, only the styles are loaded
};
class SdXMLFilter : public SdFilter
diff --git a/sd/source/filter/eppt/eppt.hxx b/sd/source/filter/eppt/eppt.hxx
index d8bbc56..f4b60b2 100644
--- a/sd/source/filter/eppt/eppt.hxx
+++ b/sd/source/filter/eppt/eppt.hxx
@@ -134,8 +134,8 @@ enum PPTExOleObjEntryType
struct PPTExOleObjEntry
{
PPTExOleObjEntryType eType;
- sal_uInt32 nOfsA; // offset to the EPP_ExOleObjAtom in mpExEmbed (set at creation)
- sal_uInt32 nOfsB; // offset to the EPP_ExOleObjStg
+ sal_uInt32 nOfsA; ///< offset to the EPP_ExOleObjAtom in mpExEmbed (set at creation)
+ sal_uInt32 nOfsB; ///< offset to the EPP_ExOleObjStg
::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > xControlModel;
::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape > xShape;
diff --git a/sd/source/filter/eppt/escherex.hxx b/sd/source/filter/eppt/escherex.hxx
index 1d053af..76d5ee8 100644
--- a/sd/source/filter/eppt/escherex.hxx
+++ b/sd/source/filter/eppt/escherex.hxx
@@ -30,23 +30,20 @@
#define _PptEscherEX_HXX
#include <filter/msfilter/escherex.hxx>
-// ---------------------------------------------------------------------------------------------
-// Werte fuer den sal_uLong im PPT_PST_TextHeaderAtom
+/// Values for the sal_uLong in PPT_PST_TextHeaderAtom.
enum PPT_TextHeader
{
PPTTH_TITLE,
PPTTH_BODY,
PPTTH_NOTES,
PPTTH_NOTUSED,
- PPTTH_OTHER, // Text in a Shape
- PPTTH_CENTERBODY, // Subtitle in Title-Slide
- PPTTH_CENTERTITLE, // Title in Title-Slide
- PPTTH_HALFBODY, // Body in two-column slide
- PPTTH_QUARTERBODY // Body in four-body slide
+ PPTTH_OTHER, ///< Text in a Shape
+ PPTTH_CENTERBODY, ///< Subtitle in Title-Slide
+ PPTTH_CENTERTITLE, ///< Title in Title-Slide
+ PPTTH_HALFBODY, ///< Body in two-column slide
+ PPTTH_QUARTERBODY ///< Body in four-body slide
};
-// ---------------------------------------------------------------------------------------------
-
class PptEscherEx : public EscherEx
{
sal_uInt32 ImplDggContainerSize();
@@ -74,7 +71,6 @@ class PptEscherEx : public EscherEx
using EscherEx::EnterGroup;
};
-
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sd/source/filter/eppt/pptexsoundcollection.hxx b/sd/source/filter/eppt/pptexsoundcollection.hxx
index 99e3de3..f047a85 100644
--- a/sd/source/filter/eppt/pptexsoundcollection.hxx
+++ b/sd/source/filter/eppt/pptexsoundcollection.hxx
@@ -55,7 +55,7 @@ class ExSoundEntry
ExSoundEntry(const rtl::OUString& rSoundURL);
- /// @return the size of a complete SoundContainer
+ /// @return size of a complete SoundContainer.
sal_uInt32 GetSize( sal_uInt32 nId ) const;
void Write( SvStream& rSt, sal_uInt32 nId ) const;
};
@@ -66,7 +66,7 @@ class ExSoundCollection
sal_uInt32 GetId(const rtl::OUString&);
- /// @return the size of a complete SoundCollectionContainer
+ /// @return size of a complete SoundCollectionContainer.
sal_uInt32 GetSize() const;
void Write( SvStream& rSt ) const;
diff --git a/sd/source/filter/html/htmlex.hxx b/sd/source/filter/html/htmlex.hxx
index 2bde062..6c008a6 100644
--- a/sd/source/filter/html/htmlex.hxx
+++ b/sd/source/filter/html/htmlex.hxx
@@ -87,9 +87,7 @@ public:
void SetContext( sal_uInt16 nResId, const String& rURL1, const String& rURL2 );
};
-// =====================================================================
-// this class exports an Impress Document as a HTML Presentation
-// =====================================================================
+/// this class exports an Impress Document as a HTML Presentation.
class HtmlExport
{
std::vector< SdPage* > maPages;
@@ -133,8 +131,8 @@ class HtmlExport
bool mbHiddenSlides;
bool mbEndless;
- bool mbUserAttr; // die folgenden Farben werden fuer das <body>
- Color maTextColor; // tag genutzt, wenn mbUserAttr true ist
+ bool mbUserAttr;
+ Color maTextColor; ///< The following colors are used for the <body> tag if mbUserAttr is true.
Color maBackColor;
Color maLinkColor;
Color maVLinkColor;
@@ -149,7 +147,7 @@ class HtmlExport
String** mpPageNames;
String** mpTextFiles;
- String maExportPath; // Das Ausgabeverzeichnes bzw. die URL
+ String maExportPath; ///< output directory or URL.
String maIndexUrl;
String maURLPath;
String maCGIPath;
diff --git a/sd/source/ui/animations/motionpathtag.hxx b/sd/source/ui/animations/motionpathtag.hxx
index 12ff8ee..867a81f 100644
--- a/sd/source/ui/animations/motionpathtag.hxx
+++ b/sd/source/ui/animations/motionpathtag.hxx
@@ -34,12 +34,7 @@ namespace sd {
class View;
class CustomAnimationPane;
-/*************************************************************************
-|*
-|* Basisklasse fuer alle Funktionen
-|*
-\************************************************************************/
-
+/// Base class for all functions.
class MotionPathTag : public SmartTag, public IPolyPolygonEditorController, public SfxListener, public ::com::sun::star::util::XChangesListener
{
public:
@@ -48,10 +43,10 @@ public:
SdrPathObj* getPathObj() const { return mpPathObj; }
- /** returns true if the SmartTag handled the event. */
+ /// @return true if the SmartTag handled the event.
virtual bool MouseButtonDown( const MouseEvent&, SmartHdl& );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool KeyInput( const KeyEvent& rKEvt );
// callbacks from sdr view
diff --git a/sd/source/ui/annotations/annotationtag.hxx b/sd/source/ui/annotations/annotationtag.hxx
index 7732467..9deae0b 100644
--- a/sd/source/ui/annotations/annotationtag.hxx
+++ b/sd/source/ui/annotations/annotationtag.hxx
@@ -39,16 +39,16 @@ public:
AnnotationTag( AnnotationManagerImpl& rManager, ::sd::View& rView, const css::uno::Reference< css::office::XAnnotation >& xAnnotation, Color& rColor, int nIndex, const Font& rFont );
virtual ~AnnotationTag();
- /** returns true if the SmartTag handled the event. */
+ /// @return true if the SmartTag handled the event.
virtual bool MouseButtonDown( const MouseEvent&, SmartHdl& );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool KeyInput( const KeyEvent& rKEvt );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool RequestHelp( const HelpEvent& rHEvt );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool Command( const CommandEvent& rCEvt );
// callbacks from sdr view
@@ -61,8 +61,6 @@ public:
void Move( int nDX, int nDY );
bool OnMove( const KeyEvent& rKEvt );
- // ---
-
BitmapEx CreateAnnotationBitmap(bool);
css::uno::Reference< css::office::XAnnotation > GetAnnotation() const { return mxAnnotation; }
diff --git a/sd/source/ui/presenter/CanvasUpdateRequester.hxx b/sd/source/ui/presenter/CanvasUpdateRequester.hxx
index 0800a27..e2fe548 100644
--- a/sd/source/ui/presenter/CanvasUpdateRequester.hxx
+++ b/sd/source/ui/presenter/CanvasUpdateRequester.hxx
@@ -41,8 +41,8 @@ namespace sd { namespace presenter {
class CanvasUpdateRequester : private ::boost::noncopyable
{
public:
- /** Return the Canvas UpdateRequester object for the given shared
- canvas. A new object is created when it does not already exist.
+ /** @return the Canvas UpdateRequester object for the given shared canvas.
+ A new object is created when it does not already exist.
*/
static ::boost::shared_ptr<CanvasUpdateRequester> Instance (
const css::uno::Reference<css::rendering::XSpriteCanvas>& rxCanvas);
More information about the Libreoffice-commits
mailing list