aboutsummaryrefslogtreecommitdiffhomepage
path: root/tools/bookmaker
Commit message (Collapse)AuthorAge
...
* Enable conditional-uninitialized flagGravatar Kevin Lubick2018-01-05
| | | | | | | | | Bug: skia:7462 Cq-Include-Trybots: skia.primary:Test-Debian9-Clang-GCE-CPU-AVX2-x86_64-Release-All-SKNX_NO_SIMD Change-Id: I1c0a09984bf28a5c620a89af56040f018bae6310 Reviewed-on: https://skia-review.googlesource.com/90941 Commit-Queue: Kevin Lubick <kjlubick@google.com> Reviewed-by: Mike Klein <mtklein@chromium.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>
* support srgb flag in bookmakerGravatar Cary Clark2018-01-03
| | | | | | | | | | | | | | | allow examples to work with colorspace fix point array plural form fix spacing after private message add some SkImage documentation TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=90360 Bug: skia:6898 Change-Id: I045ee68e7dd9747ec5d40d95588bbc1594c45366 Reviewed-on: https://skia-review.googlesource.com/90360 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* update image doc and minor bookmaker fixesGravatar Cary Clark2018-01-02
| | | | | | | | | | | | | | | | | | | | image doc is still a work in progress. Update online version to latest; updating include header is still a ways off. Remove SkPaint::flatten() example since parameter is not publicly accessible. Minor changes to fix typedef and std::function references. TBR=rmistry@google.com Docs-Preview: https://skia.org/?cl=87120 Bug: skia:6898 Change-Id: I3553bc5fca97c5997aa61ea034b5ca10cb10df75 Reviewed-on: https://skia-review.googlesource.com/87120 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* fix bookmaker return valueGravatar Cary Clark2017-12-21
| | | | | | | | | | | | | | | | | | | | | crosscheck in bookmaker allows discovery of multiple errors, but fails to return that an error occurred. Fix SkSurface so it is up to date with includes. Add include parameter name in SkSurface. Allow longer parameter descriptions. TBR=bsalomon@google.com,rmistry@google.com Docs-Preview: https://skia.org/?cl=88041 Bug: skia:6898 Change-Id: I9daf83f7f6753b3d1dc996a76e4693b3b8d6798c Reviewed-on: https://skia-review.googlesource.com/88041 Reviewed-by: Brian Salomon <bsalomon@google.com> Reviewed-by: Ravi Mistry <rmistry@google.com> Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@google.com>
* stabilize catalogGravatar Cary Clark2017-12-12
| | | | | | | | | | | | | | | Identify volatile stdout from examples to make site/user/api/catalog.htm the same from one run to the next. Remove a debugging printf from mdOut.cpp Docs-Preview: https://skia.org/?cl=83941 Bug: skia:6898 Change-Id: I52c7527394e00934f57bb6c02ff33b422f4770ca Reviewed-on: https://skia-review.googlesource.com/83941 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix running on linuxGravatar Cary Clark2017-12-12
| | | | | | | | | | | | | | | | | Verified that bookmaker running on Linux generates same .md files as when it runs on Windows. Fixed a directory separator bug. Catalog has slightly different output because some tests generate volatile output -- need to fix this in general. Docs-Preview: https://skia.org/?cl=83940 Bug: skia:6898 Change-Id: I3c56c372d155b1b14a1fbdf616fa79f420b78150 Reviewed-on: https://skia-review.googlesource.com/83940 Commit-Queue: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@google.com>
* working on image and nightly housekeeping botGravatar Cary Clark2017-12-11
| | | | | | | | | | | | | | | | Add more examples and docs for SkImage; still a ways to go. Fix bit-rotted examples. Add typedef support. Add json driver to pick files to work on; remove special-casing. Fix unordered map traversal that made md output unreliable. TBR=rmistry@google.com Docs-Preview: https://skia.org/?cl=80060 Bug: skia:6898 Change-Id: Ib8eb9fdfa5a9db61c8332e657fa2e2f4b96a665f Reviewed-on: https://skia-review.googlesource.com/80060 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
* working on skimageGravatar Cary Clark2017-12-01
| | | | | | | | | | | working on skimage Docs-Preview: https://skia.org/?cl=76562 Bug: skia: Change-Id: I288d2a9bbbdf01bff9efd5f0a9d308d3c76391a4 Reviewed-on: https://skia-review.googlesource.com/76562 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: 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>
* Bookmaker to work on Linux.Gravatar Ben Wagner2017-11-08
| | | | | | | | | | This also updates one fiddle example which used SkTypeface::kBold, which is now private. Change-Id: I799b64bfaa377d02f0a045d2f077410d4f38413d Reviewed-on: https://skia-review.googlesource.com/68902 Reviewed-by: Cary Clark <caryclark@google.com> Commit-Queue: Ben Wagner <bungeman@google.com>
* Fix bookmaker compile warningGravatar Brian Osman2017-11-01
| | | | | | | | Bug: skia: Change-Id: Iee8cf7f1d51f965e19bfc69190f975184bd7ff7a Reviewed-on: https://skia-review.googlesource.com/66148 Commit-Queue: Cary Clark <caryclark@google.com> Reviewed-by: Cary Clark <caryclark@google.com>
* 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>
* 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 trailing whitespace.Gravatar Ben Wagner2017-10-09
| | | | | | | | | | | Also adds a presubmit to prevent adding trailing whitespace to source code in the future. Change-Id: I41a4df81487f6f00aa19b188f0cac6a3377efde6 Reviewed-on: https://skia-review.googlesource.com/57380 Reviewed-by: Ravi Mistry <rmistry@google.com> Reviewed-by: Mike Reed <reed@google.com> Commit-Queue: Ben Wagner <bungeman@google.com>
* 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>
* work on generation of rect, bitmap, matrix markupGravatar Cary Clark2017-09-19
| | | | | | | | | TBR=caryclark@google.com Bug: skia:6898 Change-Id: I501d87341afa2f8d548b4d02415375032a46e96e Reviewed-on: https://skia-review.googlesource.com/47420 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: 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>
* remove need for command flags castGravatar Cary Clark2017-09-14
| | | | | | | | | | TBR=mtklein@google.com Bug: skia: 6898 Change-Id: I1c83fe67cbfb978f15ebcbb9081ac4d4a8f00e4a Reviewed-on: https://skia-review.googlesource.com/46680 Reviewed-by: Mike Klein <mtklein@google.com> Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: 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>
* try again to fix method linksGravatar Cary Clark2017-08-25
| | | | | | | | | | | | | generate method links from fiddle names to keep them consistent and unique. Docs-Preview: https://skia.org/?cl=38727 Bug: skia:6898 Change-Id: I3434801b46002a3a9095e007d456e9e871307304 Reviewed-on: https://skia-review.googlesource.com/38727 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
* fix generated linksGravatar Cary Clark2017-08-25
| | | | | | | | | | | | | | | qualify bookmaker links to remove file reference if intra-file and add class reference if part of a class TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=38722 Bug: skia: 6898 Change-Id: Ie0548485a6e3f596efc0f15b819bd5060e983a5b Reviewed-on: https://skia-review.googlesource.com/38722 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: 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>
* fix output header in bookmakerGravatar Cary Clark2017-07-28
| | | | | | | | | | | | change underscore to space if needed remove bmh_ prefix TBR=caryclark@google.com Bug: skia: Change-Id: I9d4d29c7ff91d9d29bf8740d163724f371e5e211 Reviewed-on: https://skia-review.googlesource.com/28044 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-09 15:38:00 +0000