aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/user/api/SkIRect_Reference.md
Commit message (Collapse)AuthorAge
* fix bookmaker typoGravatar Cary Clark2018-05-18
| | | | | | | | | | | | | Fix one character and update the web documentation. Docs-Preview: https://skia.org/?cl=128938 TBR=robertphillips@google.com Bug: skia:6898 Change-Id: I4525ef8d3bae85ef1d63f84ff414a32b9935ae0e Reviewed-on: https://skia-review.googlesource.com/128938 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org> Auto-Submit: Cary Clark <caryclark@skia.org>
* Documentation refreshGravatar Cary Clark2018-05-16
| | | | | | | | | | | | | | | | | | | | | | | | | | | - add links to types within methods - add check to see that all references and definitions match - add style to tables to make them easier to read - use https everywhere - remove trailing spaces - move overview inside class - split class and struct in summary tables - add missing #Line - clean up SkImageInfo constant documentation - work on SkColor documentation - allow common phrases to take different parameters - add more flexibility to generated tables - tighten token parent requirements - generalize deprecated and example interfaces - detect inner constructors R=caryclark@google.com Docs-Preview: https://skia.org/?cl=121799 Bug: skia:6898 Change-Id: Ia75a23740b80259460916890b310e2a9f024962a Reviewed-on: https://skia-review.googlesource.com/121799 Commit-Queue: Cary Clark <caryclark@skia.org> Auto-Submit: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix bm gmGravatar Cary Clark2018-04-12
| | | | | | | | | | | | | gm bug7792 had wrong dimensions and clipped out half the draws bm SkRect_Reference.bmh referred to SkIPoint::center.. which has been removed. Docs-Preview: https://skia.org/?cl=120640 Bug: skia:6898 Change-Id: Id4c59c82005e1060d0ca933d9a3650fe4f121264 Reviewed-on: https://skia-review.googlesource.com/120640 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix bugs exposed by documenting SkImageInfoGravatar Cary Clark2018-04-03
| | | | | | | | | | | | | | | | | | | | | | | | - More rigorous symbol identification creates additional links, and finds spurious errors like unnecessary parentheses. - Fixed code to allow preprocessor directives in #Code blocks (still more to do). - Fixed examples waiting on fiddle updates. - Make SkImageInfo officially documented (update in status.json). - Fixed enum indentation. Docs-Preview: https://skia.org/?cl=115656 Bug: skia:6898 Change-Id: Ifcf5cfd3f6c03b3b83155c898b2b035a2f3d443c Reviewed-on: https://skia-review.googlesource.com/115656 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* update SkIRect centerx centery docsGravatar Cary Clark2018-03-22
| | | | | | | | | | | R=caryclark@google.com Docs-Preview: https://skia.org/?cl=115820 Bug: skia:6898 Change-Id: I1d3c32d40ed4000f060a535cbcd20b39d0ff9fc3 Reviewed-on: https://skia-review.googlesource.com/115820 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* more SkImageInfo docsGravatar Cary Clark2018-03-20
| | | | | | | | | | | | | | | fix a couple of fiddles with changed output rewrite some SkSurface image makers move towards replacing SkImageInfo.h R=caryclark@google.com Docs-Preview: https://skia.org/?cl=115163 Bug: skia:6898 Change-Id: Id9895b051cd457336c30250a69cf95359d1d34d7 Reviewed-on: https://skia-review.googlesource.com/115163 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* more imageinfo text and warnings and cleanupGravatar Cary Clark2018-03-16
| | | | | | | | | | | | | | | | | | | more imageinfo text rewrote many examples to fix newly exposed compiler warnings marked a couple of YUV method bodies as deprecated also cleaned up line endings to use the linux style R=bsalomon@google.com TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=112302 Bug: skia:6898 Change-Id: I89626a27353aa84526f9b9475d927bd0e9d8f0d5 Reviewed-on: https://skia-review.googlesource.com/112302 Reviewed-by: Brian Salomon <bsalomon@google.com> Commit-Queue: Cary Clark <caryclark@google.com>
* work in imageinfo and phrase substitutionGravatar Cary Clark2018-03-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds the ability to define long phrases in one place and refer to those phrases in many places. Bookmaker has new syntax to support phrase substitution. When it encounters #some_phrase_reference# It substitutes the body of #PhraseDef some_phrase_reference text to substitute when encountering the phrase ## The phrase label must start with a lowercase letter, and be bracketed by single hash marks, without spaces between the label and the hash marks. Docs-Preview: https://skia.org/?cl=111224 TBR=caryclark@google.com Bug: skia:6898 Change-Id: I12c57d916ccedbd86b421377d117399150ada72a Reviewed-on: https://skia-review.googlesource.com/111224 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* fix Rect docGravatar Cary Clark2018-02-20
| | | | | | | | | | | move the #Line directive to make bookmaker happy Docs-Preview: https://skia.org/?cl=108740 Bug: skia:6898 Change-Id: I8b993bab6b4f69cc266941e281a00a945f32f25e Reviewed-on: https://skia-review.googlesource.com/108740 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix IRect docGravatar Cary Clark2018-02-20
| | | | | | | | | | | | | | | | | Florin pointed out docs that used SkPoint where SkIPoint was intended. This was caused by the original documentation guessing that 'points' referred to one and not the other. For now, use IPoint explicitly in the documentation to get around this. Docs-Preview: https://skia.org/?cl=108569 Bug: skia:6898 Change-Id: I12bac1d4cf82a614bee98895f12e4f99add2dbd7 Reviewed-on: https://skia-review.googlesource.com/108569 Reviewed-by: Florin Malita <fmalita@chromium.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* improve bookmaker defines and referencesGravatar Cary Clark2018-02-16
| | | | | | | | | | | | | | | | generating replacement includes exposed errors mostly dealing with globals like SkAlphaType and members. Rewrite finding and resolving links to hopefully make this area more robust. TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=107160 Bug: skia:6898 Change-Id: I9b8025160203d204286f3f6ca0cebd70da6253b4 Reviewed-on: https://skia-review.googlesource.com/107160 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* add subtopics to all methodsGravatar Cary Clark2018-02-07
| | | | | | | | | | | | add self-check looking for #In markup on every method, pointing to an existing #Subtopic to reference the method. Docs-Preview: https://skia.org/?cl=104325 Bug: skia:6898 Change-Id: I749a25b9a43033ae68d193249b2c0b810dcf8fc8 Reviewed-on: https://skia-review.googlesource.com/104325 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* Update markdown filesGravatar Update Docs2018-02-07
| | | | | | | | | | | | Automatic commit by the Housekeeper-Nightly-Bookmaker bot. TBR=update-docs@skia.org NO_MERGE_BUILDS Change-Id: I66f6cd307306d234a11ec3384041df514237be46 Reviewed-on: https://skia-review.googlesource.com/104820 Reviewed-by: Update Docs <update-docs@skia.org> Commit-Queue: Update Docs <update-docs@skia.org>
* Update markdown filesGravatar Update Docs2018-02-06
| | | | | | | | | | | | Automatic commit by the Housekeeper-Nightly-Bookmaker bot. TBR=update-docs@skia.org NO_MERGE_BUILDS Change-Id: Ia76c50925d8fc0a982ebd6c0012a0e7eb15d479f Reviewed-on: https://skia-review.googlesource.com/104380 Reviewed-by: Update Docs <update-docs@skia.org> Commit-Queue: Update Docs <update-docs@skia.org>
* fix bookmaker nightlyGravatar Cary Clark2018-02-06
| | | | | | | | | | | | | | | | | | | - mark the interfaces that use SkMask as deprecated - add more autogenerated subtopics - make subtopic names singular, avoiding collision with Skia names - simplify #Deprecated and #Bug tags - add "#Deprecated soon" to note things to be deprecated - fix some spelling errors - refresh web docs - add self-check functionality to find methods outside subtopics TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=102150 Bug: skia:6898 Change-Id: I0e742a56d49dccd4409bb68eed9167c8ad7611ce Reviewed-on: https://skia-review.googlesource.com/102150 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* auto table generationGravatar Cary Clark2018-02-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Replace manually entered summary tables with ones that are populated and sorted by bookmaker. This introduces a slight regression for anonymous enums but fixes a lot of bugs and omissions. The format is #Topic somethingTopical #Populate ## where somethingTopical is one of Subtopics, Constructors, Constants, Classes_and_Structs, Members, Member_Functions, and Related_Functions. Fix the bad formatting in SkCanvas reference. The #Error tag was was corrupting the markdown table. Remove the tag and replace it with #NoExample. Next up: revise self-check to know about populated topics. TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=102080 Bug: skia:6898 Change-Id: Idef5d1c14c740c18a81d6a5106182788dd2a09e1 Reviewed-on: https://skia-review.googlesource.com/102080 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* generate tables instead of manual entryGravatar Cary Clark2018-01-30
| | | | | | | | | | | | | | | | | | | | | | | | | - make descriptions of table entries phrases instead of sentences; lower case start, no ending period (not enforced, yet) - add #Line markup to move one line descriptions to the #Method body. Later, will generate tables like Member_Functions from this - add #In markup to associate a #Method with a #Subtopic. Later, will generate tables of related methods from this - remove return type from operator overloads in tables - add new colorTypes to examples that index into arrays of strings to name them Docs-Preview: https://skia.org/?cl=100422 TBR=caryclark@google.com Bug: skia:6898 Change-Id: I8558048866369f419f1944832b99c05da3fd52bb Reviewed-on: https://skia-review.googlesource.com/100422 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* working on global enum and image infoGravatar Cary Clark2018-01-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Added global enum support. That exposed one big hole in bookmaker: The topic overview should not be in the class or struct if the topic includes multiple objects, which is the case for SkImageInfo and enums like SkColorType. This straightens that out, and then used that knowledge to strengthen the topics in SkRect as a test. Now SkRect has more groups of methods, and can expose and link to sets of methods with the same name. This work also is getting ready for tightening SeeAlso data, to be checked as part of the bots' tasks soon. Also, remove links from markup for lowercase method names unless the reference has trailing parentheses. TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=98782 Bug: skia:6898 Change-Id: I35419c9789da17e272047bf7b9c95b1cf44bb7fe Reviewed-on: https://skia-review.googlesource.com/98782 Commit-Queue: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@google.com>
* self check and correctionsGravatar Cary Clark2018-01-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | Add self-checking code that looks to see that overview is populated and alphabetized. Eventually, this will self-check to see if methods are collected into subtopics and have reciprocal 'see also' data. Standardize phrases so that they don't start with a capital or end with a period. Self-check is a work in progress, so it is not yet run by the bookmaker bots. The self-check should run cleanly, however. To run it: ./out/skia/bookmaker -b docs -k The expected output is doc stats. Self-check errors such as missing methods in the overview would be reported here if there are any. TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=93621 Bug: skia:6898 Change-Id: I8f1f817a7b083b13138ee33d1aa090445e9304c6 Reviewed-on: https://skia-review.googlesource.com/93621 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* update bookmaker to ToTGravatar Cary Clark2018-01-11
| | | | | | | | | | | | | | | more image docs, still not done add ability to comment out non-working examples easily start work on additional self-checks clean up use of this-> in docs TBR=reed@google.com Docs-Preview: https://skia.org/?cl=91720 Bug: skia:6898 Change-Id: I706ab8145290e53ab67d3f509ccf4e1225adb3c3 Reviewed-on: https://skia-review.googlesource.com/91720 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix example and suppress MakeLargestGravatar Cary Clark2018-01-08
| | | | | | | | | | | | | | | add rule to skip MakeLargest until general rule suppressing contents of #if SK_SUPPORT_LEGACY_... can be added. Docs-Preview: https://skia.org/?cl=92221 Bug: skia:6898 Change-Id: Ic2783bf110098626f5e846c3765e72aefbb4398d Reviewed-on: https://skia-review.googlesource.com/92221 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Mike Reed <reed@google.com> Reviewed-by: Cary Clark <caryclark@skia.org>
* limit bookmaker status outputGravatar Cary Clark2018-01-04
| | | | | | | | | | | | | | streamline 'working as intended' output notify when output changed fix bug which appended output incorrectly to SkBitmap.h fix bug that hid bad SkSurface.h from detection Docs-Preview: https://skia.org/?cl=90162 Bug: skia:6898 Change-Id: I067cfe5bbad706345fb5cd540cdc3835ce22d822 Reviewed-on: https://skia-review.googlesource.com/90162 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix SkIRect doc to match includeGravatar Cary Clark2018-01-04
| | | | | | | | | | | changed int to int32_t as needed Docs-Preview: https://skia.org/?cl=90840 Bug: skia:6898 Change-Id: I909168314acc5ee007d4a4d4e39062e652c7d6c6 Reviewed-on: https://skia-review.googlesource.com/90840 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* bookmaker refreshGravatar Cary Clark2017-11-27
| | | | | | | | | | | | | | Add support for more operator overloads. Add SkSurface, SkPoint, SkIPoint, SkIPoint16 docs. (SkImage doc skeleton added, but not really started.) Force recompile all examples. Docs-Preview: https://skia.org/?cl=67726 Bug: skia:6898 Change-Id: If9e2d23f79d5db64146dd22588f5cac970614b8a Reviewed-on: https://skia-review.googlesource.com/67726 Commit-Queue: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@google.com>
* 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>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-17 10:27:13 +0000