aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
Commit message (Collapse)AuthorAge
...
* filling holes in canvas docGravatar Cary Clark2017-11-02
| | | | | | | | | | | | filling holes in canvas doc Docs-Preview: https://skia.org/?cl=66920 TBR=caryclark@google.com Bug: skia:6898 Change-Id: I3a211df5f19ecfbfa0bb060bb6d55005a38cd360 Reviewed-on: https://skia-review.googlesource.com/66920 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* streamline doc menusGravatar Cary Clark2017-11-01
| | | | | | | | | | No-Try: true Docs-Preview: https://skia.org/?cl=66145 Bug: skia:6898 Change-Id: I11acd8c17db5faa833ca38550d82819e799dd311 Reviewed-on: https://skia-review.googlesource.com/66145 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* catalogerGravatar Cary Clark2017-10-31
| | | | | | | | | Docs-Preview: https://skia.org/?cl=64900 Bug: skia:6898 Change-Id: Ifbaf909854680a88060f16b1559863cc124aaa7a Reviewed-on: https://skia-review.googlesource.com/64900 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix matrix order bugGravatar Cary Clark2017-10-26
| | | | | | | | | | | corrected matrix illustration for SkMatrix::MakeTrans Docs-Preview: https://skia.org/?cl=64120 Bug: skia:6898 Change-Id: Iec8ceae6893598919349b24197f30727be892a37 Reviewed-on: https://skia-review.googlesource.com/64120 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* Add docs for SkMatrix, SkRect, SkIRect, SkBitmapGravatar Cary Clark2017-10-26
| | | | | | | | | | | | | | | Also minor changes to earlier docs. Many small changes to improve indentation in generated includes. Added support for matrix math illustrations. Docs-Preview: https://skia.org/?cl=58500 Bug: skia:6898 Change-Id: I7da58ad55f82d7fd41d19288beb2cd71730fb01f Reviewed-on: https://skia-review.googlesource.com/58500 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@skia.org>
* General clean up on bookmaker.Gravatar Cary Clark2017-10-11
| | | | | | | | | | | | | | Command line runs without error for SkBitmap, SkPath, SkRect, SkIRect, SkPixmap, SkCanvas. Docs-Preview: https://skia.org/?cl=57112 TBR: caryclark@google.com Bug: skia:6898 Change-Id: I73b69ae8ffdf0a1e6bc187dc8a9dfb28f7766faa Reviewed-on: https://skia-review.googlesource.com/57112 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* Remove carriage returns.Gravatar Ben Wagner2017-10-09
| | | | | | | | | Also add a presubmit so they don't get added to source code. Change-Id: I6a85c6a934b1068a63646a0dcc0d3a08baa96ced Reviewed-on: https://skia-review.googlesource.com/57110 Reviewed-by: Ravi Mistry <rmistry@google.com> Commit-Queue: Ben Wagner <bungeman@google.com>
* first cut at SkRect, SkIRect documentationGravatar Cary Clark2017-10-09
| | | | | | | | | | | | | | All functions should have descriptions, examples, cross-references. References and spelling have been checked. More work to do creating and organizing topics. Docs-Preview: https://skia.org/?cl=56140 Tbr: caryclark@google.com Bug: skia:6898 Change-Id: I9d1e55d04ab64874c33cac8b91534aa192c2f545 Reviewed-on: https://skia-review.googlesource.com/56140 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* starting next gaggle of docsGravatar Cary Clark2017-10-04
| | | | | | | | | | | starting next gaggle of docs Docs-Preview: https://skia.org/?cl=50264 Bug: skia:6898 Change-Id: I639795b55c0c96b2efccac13cb67592f055a75a2 Reviewed-on: https://skia-review.googlesource.com/50264 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* feedbackGravatar Cary Clark2017-09-21
| | | | | | | | | | | feedback from include review Docs-Preview: https://skia.org/?cl=49260 Bug: skia: 6898 Change-Id: Ic60980dfe53d14fd8c6973ef2f4dabb6b650cdd8 Reviewed-on: https://skia-review.googlesource.com/49260 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* missing description for FontMetricFlagsGravatar Cary Clark2017-09-15
| | | | | | | | | | | | | | | | | rearrange class descriptions to make them appear consistently inside the #Class declaration in the .bmh files. Look for the descriptions there and regenerate the .md files. Docs-Preview: https://skia.org/?cl=46523 TBR=caryclark@google.com Bug: skia: 6898 Change-Id: I00a176428725ef27667d3f23d76d6b7ff0cfced1 Reviewed-on: https://skia-review.googlesource.com/46523 Commit-Queue: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@skia.org>
* wip pixmap docsGravatar Cary Clark2017-09-14
| | | | | | | | | | | wip pixmap docs Docs-Preview: https://skia.org/?cl=42522 Bug: skia: 6898 Change-Id: I85947bc36ea057ed008b87d7bef2efa82d7c89ad Reviewed-on: https://skia-review.googlesource.com/42522 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* bookmaker spelling with fixed linux buildGravatar Cary Clark2017-09-01
| | | | | | | | | | | | | | | | | | Work on spell-checker to identify errors and isolate more concepts requiring definitions. fix linux build Docs-Preview: https://skia.org/?cl=42103 Docs-Preview: https://skia.org/?cl=41180 Tbr: caryclark@google.com Bug: skia: 6898 Change-Id: Id939b0c2915c22e0fa1b15623c1a56fbe9d4051d Reviewed-on: https://skia-review.googlesource.com/42103 Reviewed-by: Cary Clark <caryclark@google.com> Commit-Queue: Cary Clark <caryclark@google.com>
* Revert "wip spelling mania"Gravatar Cary Clark2017-09-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This reverts commit da65a0489ae429f026bad32c9a0ef2010f40e175. Reason for revert: fails to build on linux Original change's description: > wip spelling mania > > Work on spell-checker > to identify errors and > isolate more concepts > requiring definitions. > > Docs-Preview: https://skia.org/?cl=41180 > TBR: reed@google.com > Bug: skia: 6898 > Change-Id: I0759beb42eaf6095908a9bd7decfcd0026253609 > Reviewed-on: https://skia-review.googlesource.com/41180 > Reviewed-by: Cary Clark <caryclark@skia.org> > Commit-Queue: Cary Clark <caryclark@skia.org> TBR=caryclark@google.com,caryclark@skia.org Change-Id: I173e50ea5b51273cd316ac9964af3a498b5300e4 No-Presubmit: true No-Tree-Checks: true No-Try: true Bug: skia: 6898 Reviewed-on: https://skia-review.googlesource.com/42140 Reviewed-by: Cary Clark <caryclark@google.com> Commit-Queue: Cary Clark <caryclark@google.com>
* wip spelling maniaGravatar Cary Clark2017-09-01
| | | | | | | | | | | | | | | Work on spell-checker to identify errors and isolate more concepts requiring definitions. Docs-Preview: https://skia.org/?cl=41180 TBR: reed@google.com Bug: skia: 6898 Change-Id: I0759beb42eaf6095908a9bd7decfcd0026253609 Reviewed-on: https://skia-review.googlesource.com/41180 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* fix param return descriptionsGravatar Cary Clark2017-08-30
| | | | | | | | | | | | | | enforce that param and return descriptions are phrases (begin with lower case, no trailing period). Docs-Preview: https://skia.org/?cl=40767 Bug: skia: 6898 Change-Id: Ib5f2a02441673f71c0780d81c5e4c61200a678e3 Reviewed-on: https://skia-review.googlesource.com/40767 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* work on pathGravatar Cary Clark2017-08-30
| | | | | | | | | | | | | | | | | Work on SkPath.h documentation; fixed self-consistency bugs identified by bookmaker. Fixed a couple of minor typos in SkPath.h itself. Also brought SkPaint and SkCanvas docs up to date. TBR=reed@google.com Docs-Preview: https://skia.org/?cl=39040 Bug: skia: 6898 Change-Id: Id89d4e2fa7fb6ee2e3cbec7ea762e06308b67d8b Reviewed-on: https://skia-review.googlesource.com/39040 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@skia.org>
* update canvas doc, primarily readpixels and writepixelsGravatar Cary Clark2017-08-24
| | | | | | | | | | | | | | also fixed minor bookmaker bugs so canvas include and online docs are (bookmaker detected) error-free TBR=reed@google.com Docs-Preview: https://skia.org/?cl=37840 Bug: skia: Change-Id: Ifcec9c751105444047c37d89fd984dbd4dfd1913 Reviewed-on: https://skia-review.googlesource.com/37840 Reviewed-by: Cary Clark <caryclark@google.com> Commit-Queue: Cary Clark <caryclark@skia.org>
* fix links and missing constructorGravatar Cary Clark2017-08-04
| | | | | | | | | Docs-Preview: https://skia.org/?cl=31145 Bug: skia: 6898 Change-Id: Ic94a15551f3683d9de5d3bda53394d2efce0d6a4 Reviewed-on: https://skia-review.googlesource.com/31145 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* canvas include checkpointGravatar Cary Clark2017-08-03
| | | | | | | | | | | | All fixes to bookmaker to allow creating SkCanvas.h Docs-Preview: https://skia.org/?cl=29022 TBR=caryclark@google.com Bug: skia: 6898 Change-Id: If10638fbc77cfe680f21868c97f9c0643b87ebf9 Reviewed-on: https://skia-review.googlesource.com/29022 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix self referencesGravatar Cary Clark2017-07-31
| | | | | | | | | | | | | | | try removing self references in method definitions. If this creates awkward wording, it can always be allowed in another CL. Also tighten rules for identifying function references in include comments. R=briansoman@google.com, caryclark@google.com TBR=reed@google.com Bug: skia:6898 Change-Id: I1a0e6b2a76dacfe71d134deb4589fb74e6611a03 Reviewed-on: https://skia-review.googlesource.com/28624 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix capitalizationGravatar Cary Clark2017-07-31
| | | | | | | | | | | | | | | Fix 'arcs' at sentence start to Arcs. This fix corrected other capitalizations as well, and exposed some mis-capitalizations in the bmh doc. R=brianosman@google.com TBR=reed@google.com Bug: skia: Change-Id: I4d51388556f7e8ff868a9236ce76745915560327 Reviewed-on: https://skia-review.googlesource.com/28241 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* bookmaker generated site docsGravatar Cary Clark2017-07-28
| | | | | | | | | | | | The documents were generated by running tools/bookmaker against docs/*.bmh No-Try: true Docs-Preview: https://skia.org/?cl=28002 Change-Id: I7d7dd73cdea4a234c6175646d5b8938e1af3117a Reviewed-on: https://skia-review.googlesource.com/28002 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* bookmaker initial checkinGravatar Cary Clark2017-07-28
| | | | | | | | | | | | bookmaker is a tool that generates documentation backends from a canonical markup. Documentation for bookmaker itself is evolving at docs/usingBookmaker.bmh, which is visible online at skia.org/user/api/bmh_usingBookmaker Change-Id: Ic76ddf29134895b5c2ebfbc84603e40ff08caf09 Reviewed-on: https://skia-review.googlesource.com/28000 Commit-Queue: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@google.com>
* Remove quickstart docs.Gravatar tfarina2015-05-11
| | | | | | | | | | It is now obsolete by skia.org. All the relevant doc is hosted there now. BUG=None R=mtklein@google.com Review URL: https://codereview.chromium.org/1138833005
* Fix references to https://sites.google.com/site/skiadocs/.Gravatar Thiago Farina2015-02-03
| | | | | | | | | | Point them to their equivalent in https://skia.org. BUG=None R=hcm@google.com, jcgregorio@google.com NOTRY=true Review URL: https://codereview.chromium.org/856353004
* Remove references to out/Debug/tests executable.Gravatar tfarina2014-10-09
| | | | | | | | | | | This target does not exists anymore, it was folded into out/Debug/dm. You can't do `ninja -C out/Debug tests` either anymore. BUG=None TEST=None R=mtklein@google.com Review URL: https://codereview.chromium.org/638913005
* warn that docs/quickstart.md is out of sync with official docsGravatar commit-bot@chromium.org2014-04-21
| | | | | | | | | | | | | | (SkipBuildbotRuns) NOTREECHECKS=True NOTRY=True R=halcanary@google.com, hcm@google.com, mtklein@google.com TBR=borenet Author: epoger@google.com Review URL: https://codereview.chromium.org/245283002 git-svn-id: http://skia.googlecode.com/svn/trunk@14287 2bbb7eff-a529-9590-31e7-b0007b416f81
* This is an short replacement for gclient.Gravatar commit-bot@chromium.org2014-04-16
| | | | | | | | | | | | | | Makes use of our current DEPS file to allow for a smooth transition. BUG=skia:291 NOTRY=true R=borenet@google.com, tfarina@chromium.org, epoger@google.com, mtklein@google.com Author: halcanary@google.com Review URL: https://codereview.chromium.org/191133005 git-svn-id: http://skia.googlecode.com/svn/trunk@14227 2bbb7eff-a529-9590-31e7-b0007b416f81
* Add a sample doc in markdown format.Gravatar commit-bot@chromium.org2014-01-24
BUG=skia: R=epoger@google.com, halcanary@google.com, borenet@google.com, jcgregorio@google.com, bungeman@google.com Author: mtklein@google.com Review URL: https://codereview.chromium.org/146943002 git-svn-id: http://skia.googlecode.com/svn/trunk@13175 2bbb7eff-a529-9590-31e7-b0007b416f81