update dox for LCD text
git-svn-id: http://skia.googlecode.com/svn/trunk@2001 2bbb7eff-a529-9590-31e7-b0007b416f81
diff --git a/include/core/SkPaint.h b/include/core/SkPaint.h
index f1d5695..a1dc59c 100644
--- a/include/core/SkPaint.h
+++ b/include/core/SkPaint.h
@@ -159,21 +159,24 @@
return SkToBool(this->getFlags() & kSubpixelText_Flag);
}
- /** Helper for setFlags(), setting or clearing the kSubpixelText_Flag
- bit @param subpixelText true to set the subpixelText bit in the paint's flags,
- false to clear it.
- */
+ /**
+ * Helper for setFlags(), setting or clearing the kSubpixelText_Flag.
+ * @param subpixelText true to set the subpixelText bit in the paint's
+ * flags, false to clear it.
+ */
void setSubpixelText(bool subpixelText);
bool isLCDRenderText() const {
return SkToBool(this->getFlags() & kLCDRenderText_Flag);
}
- /** Helper for setFlags(), setting or clearing the kLCDRenderText_Flag bit
- @param subpixelRender true to set the subpixelRenderText bit in the paint's flags,
- false to clear it.
- */
- void setLCDRenderText(bool subpixelRender);
+ /**
+ * Helper for setFlags(), setting or clearing the kLCDRenderText_Flag.
+ * Note: antialiasing must also be on for lcd rendering
+ * @param lcdText true to set the LCDRenderText bit in the paint's flags,
+ * false to clear it.
+ */
+ void setLCDRenderText(bool lcdText);
bool isEmbeddedBitmapText() const {
return SkToBool(this->getFlags() & kEmbeddedBitmapText_Flag);