Skip to content

C
core
Kaydet (Commit) 78b55ad1 authored tarafından Norah A. Abanumay's avatar Norah A. Abanumay Kaydeden (comit) Philipp Riemer
Dosyalara gözat
Seçenekler

Convert documents to follow the doxygen standard (fdo#44502, fdo#39468) 

Change-Id: I58c73f74d53b5dc2eb462fb03664be65d4500170
Reviewed-by: 's avatarPhilipp Riemer <ruderphilipp@gmail.com>
üst b80b7ba1
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 54 additions and 69 deletions
regexp/inc/regexp/reclass.hxx
Dosyayı görüntüle @ 78b55ad1
This diff is collapsed.
sd/inc/anminfo.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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;
......
sd/inc/sdpage.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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.
*/
......
sd/inc/sdpptwrp.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -39,7 +39,7 @@ public:
sal_Bool Import();
sal_Bool Export();
/// restaures the original basic storage
/// restores the original basic storage
void PreSaveBasic();
private:
......
sd/inc/sdxmlwrp.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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
......
sd/source/filter/eppt/eppt.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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;
......
sd/source/filter/eppt/escherex.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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: */
sd/source/filter/eppt/pptexsoundcollection.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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;
......
sd/source/filter/html/htmlex.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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;
......
sd/source/ui/animations/motionpathtag.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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
......
sd/source/ui/annotations/annotationtag.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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; }
......
sd/source/ui/presenter/CanvasUpdateRequester.hxx
Dosyayı görüntüle @ 78b55ad1
......@@ -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);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment