From 8d02f304cf4d7c9f9ba9ca464b351f2042ec69d4 Mon Sep 17 00:00:00 2001 From: Devon Carew Date: Tue, 12 Apr 2016 13:08:57 -0700 Subject: [PATCH] update styles for the generated dartdocs (#3276) * styles updates for the api docs * update library docs * use the new --favion and --use-categories options for dartdoc --- dev/dartdoc.dart | 6 +- dev/docs/favicon.ico | Bin 0 -> 3921 bytes dev/docs/styles.html | 70 ++++++++++++++++++- packages/flutter/lib/animation.dart | 2 +- packages/flutter/lib/material.dart | 4 +- packages/flutter/lib/src/material/icon.dart | 1 + packages/flutter/lib/src/material/icons.dart | 2 +- packages/flutter_test/lib/flutter_test.dart | 2 +- 8 files changed, 79 insertions(+), 8 deletions(-) create mode 100644 dev/docs/favicon.ico diff --git a/dev/dartdoc.dart b/dev/dartdoc.dart index 2d31151379..db59ba3627 100755 --- a/dev/dartdoc.dart +++ b/dev/dartdoc.dart @@ -41,13 +41,15 @@ dependencies: if (code != 0) exit(code); - // Generate the documentation; we require dartdoc >= 0.9.3+1. + // Generate the documentation; we require dartdoc >= 0.9.4. List args = [ 'global', 'run', 'dartdoc', '--header', 'styles.html', '--header', 'analytics.html', '--dart-sdk', '../../bin/cache/dart-sdk', - '--exclude', 'temp_doc' + '--exclude', 'temp_doc', + '--favicon=favicon.ico', + '--use-categories' ]; for (String libraryRef in _libraryRefs()) { String name = _entityName(libraryRef); diff --git a/dev/docs/favicon.ico b/dev/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..71344eea5b82203bc152444bcc4ffcabc901b907 GIT binary patch literal 3921 zcmeAS@N?(olHy`uVBq!ia0y~yU~m9o4mJh`hExV%QuQiw3m8DaroyTsw;(sQ zBvGLvHz%*ys=`(Ytimd<*a{@9ucQE0Qj%?}6yY17;GAESs$i;TqGzCF$EBd4U{jQm zW)`R!J5#6@ zWHEI05eRGS%wcvQ3!-cAFUm~KD@g>o%gzvL0kRmn`bcaRAPXXC00q5OKxRd1PJ~Nl zZfYLb7iK0l`dB5}KuQz4>3E^c;QHu~V~ z4a(|vT*}d99t;dzhdo^!Ln;{GMsgQ~T$TKH?rykQLncpu2b)HJ)Yi)n-)ivdCTT_p z%vrd0eV^=tJ~0-iEGEr0Vjf&mrzhodZ!@^2b;YWoskN=$V_CqdWC6t$s#*bY4<#p^ zy?3|z*Wc+nn-zB_Zl1ls@B93mclV0V+dlul|NsB}pXYCO@CxEsBH*Do!AYUjfvZu3 z>Hl($75bO+-d;X-%&Vku=fuU%2E6=s?_LMHuV3mH&&6=M_SRh41I%rW>I*MAYc7eN zm8Lz%$YfiT;+`w(J^nt9VkkVzcw@@?_XUy~i$4C%v^XQM;AlnH!RqPE98nuMP6(wY z1>L{->d?~VzMuckVhk_}toGHPSE}JtW_3YFpeJ_%!{ld7tC%9DzB|@zTf54r?ERB@ z5-0b{-M=mUxrAL?cJ&@TpXbtFrSz4(TrN~p+?5EEba1TMta5GjN#z9^bC z=eetCho?-Lq97*jBfOXGOxV(i`T9B+=1OQbpAf%$qfVA5;!Vu4*Lrc~a|<5@&-ag< z_}=CBy(J8L{2$MJoo~&%Wwrj3#hPMy$yYo~eBQ^en8&|ecgCXQ)-pd-?ISOx6?5nc zChN?S*%aU?V5icrvt4A`^K&8Yhu+6k<{B}WJ$s!$`OUq>AKx;o>~cB!mW4^p?2Gmh z2iB#}pT3US&aHo9mEtis;fDh3lV?9rmN;VgEz&6Lb z-jt7v)>KTdpZVzi&fwDgWtV&mZKi#ESl+}k_rS^Qn>FcLi=Q$#na9j?_gc)n;o|bS zXL--4c7I>DuKlI*)D`b{R|I9g33NHM;Y0Sl! zhTrTHznARKKY7{yL&b(Lj{bSxQ8qq|GbA>07MPVMwpN%03I?ePEDR7>d`x`RQX{`R zG8<}^l-(&2HfqW|!Kb-n?m~{=cVtc;dCtB2@uTLYFRm;Ta^(|mQ}wDzWIieHl(96G z?VbMi4Q*eY-S4TZ`mhQ#oR1aTWf!?*M?{Qk#LlnDcK7{P{AxAHTM`~!#MAz4{|1Yj z9sy?M*1bEeH$D73Yevy|af_FQi6KUr3M$81b8Z!KJI~sA@#49cAC_>&<-Q9z@xgk+ zImL5FdK!EycZmzmKj+tc@<^LPzH$DP9oyJ18u(XyJg|TBN2B|ncR5Mao>%;Hp&+S5 zNuhv8aaXLoWW^S*WZT2v+kSQE$JyBQgw>l)^PSOpoMU~TSJUjzUp1x+AN_O3y_(nl zb7WQ-P$Nikr!^rdmr4j{(A1jt@BU)-*aAY z%7lV4E0sSf*{=^B&bEG}C+ec7u6nNY=(jq7*JZl`-v&vzJ(bp3w7X(n@&2dl4}Dh? zTebhHxrZ)8%I1UTPPaA+i$)60(M#F-DOra($?CM~?y}^MjU}zm!^#g6@&#at!aseRE$=-&5C;X`J=Pr>EwZ`PR?2Mf*N{k7Dpxe7o6v=ifW3>PDSi zB09G^-P!7y)DQm)m8-gST5W2IWnXJ_(FeBR#V#i_bsp6&dr*B_XT}{@zFZD|&$A92 zC2GBOgv*Vt$MfnJKm3>+yZG0yzcsbmwja~0R<52f;Ypcu=MBA-rW@OLo7PqBu?#a_ zb&E^W$m+nMjK8t&28(xghRT>bAA453->mR`8G8}uzmAF%{#ve_KLa?dckuWxewdvs zDYbg9AB%^(oL$Y8JyNwVmwNIX-kWntNbt}Dp{$P`6%*#|U;EpzM}_st>RB^eL@clE zon2%wBgNdeXTsCK=!&&R4wU8{zglcB^X|%HmgCiJrN{4fO6Zrln5KvAJD0WW!d3s{ zDV7DRoH=wW?|1*SZMgT!^L<)}kdWjZ`5O;qc|~42pAXx7`-7?MhY8m^-CG5g&TU|s z@!FYv`a@3F#WS^P%d*d;M%@XF|KYvr!eh14%4X?J&+7x1*matf@5$ZD5bEEZsNU{eWK(SI&iu_t*ldUBw=Kno>i2e*@pQ~H*(d(HEHSA%bwNgh$CZGGmz?h( zaAr6DDBkvFdj)@WDMw;?|6_^k&y;rMm_JCrfBk8siQuORB1ucuq&+!Pxhf#H^V<4_ zxzibE#4pHCGx;~Q^1tj!`jo_MNmrUnwn3KHMRrylO!&aG{=PS~#NtmV|4B0!??Ox^6 zOX@L7wU+Um2P+?DoxY{I_VNFGW`p!id2Xp)JA-${O6;-YWLB~~`zh$eM{cG~-Phm7 zEik#=dCEt4X3X*Y#gA-PR;2e`pZ5IsyjNO25m#B=r2Ko1T;6nN(|N;mQ?@i2RSUm6 zQhf}DF+x+mtNt-NU(BQ}|KGM=D>EfA;i7ZimuFAHP2+xbnZJ=)%Nbf_(tdHGb8P#` zhv_prC#N2$3$tRE@XbE?MLu0JM$~ynBimH*-mrY}KaTfL#LQD^IT5Nj`*-WfnD45# zb*geJKmL$gcK>vG%#YwTT7F+V!&2;Y=B$!W`>|K-{H5Zpocit@?rLF0TG9``YS=Hm zlkv7RBgeW{P`YXRgMJ$;X|*LM(#0=n8|=BMdFJ_V(LM8}_jHsOKVP|O_1WofimjPm z>l^aS%^5PAW+g^{koj~jZIeM!BFE*Gu1j0*t&Q37`-5G` zk1&_@x20VVYO`%*e4xMSdi=$E8QYmUWG@*d`QECq-Er5d+4UU*TgcX97DeYRid@fS z%(uFmA$;6YU}evuLXRmqUK6iOFpV+O`p0m&vAS>C{D+5n3|B3<)&Fjq^uA?t?62J@ zV~L1qPA>IW7TdG!=A7mU7Uw^1o;feB?3>NC-*F+&4=10mh^dwOSGRV(8H0|_sTDHy zZp@n%Ejh10H{#;_AY-qZ@_*`@U)TI~g8qBveK}Tto2}vW^>!N#oyFUwYToI^?TgXa z*pQ?pn^yb5e;((W$M4qtSe;R#(i8H3(wXzuFJHR!A;xt2(g>xwOBsapy#!}Y zoweV2ITPKS$GiSD9-Mq_dD`m3m%hK&NV=Umang*VC(mbmtX*?`@19eA4-779JpRhC zw{F7nt?m2# code { - font-size: 14px; + font-size: 15px; + } + + pre, + pre.prettyprint { + background: inherit; + border: none; + margin: 0 0 15px 0; + padding: 8px 12px; + } + + code { + background-color: inherit; + } + + dl.dl-horizontal dt { + color: inherit; + } + + footer { + border-top: 1px solid #e8e8e8; + height: inherit; + padding-bottom: 15px; + text-transform: lowercase; + } + + footer p { + color: #828282; } diff --git a/packages/flutter/lib/animation.dart b/packages/flutter/lib/animation.dart index ad8efec305..eb86a879b2 100644 --- a/packages/flutter/lib/animation.dart +++ b/packages/flutter/lib/animation.dart @@ -4,7 +4,7 @@ /// The Flutter animation system. /// -/// See for an overview. +/// See [flutter.io/animations](https://flutter.io/animations/) for an overview. /// /// This library depends only on core Dart libraries and the `newton` package. library animation; diff --git a/packages/flutter/lib/material.dart b/packages/flutter/lib/material.dart index cd1f593336..d158559e24 100644 --- a/packages/flutter/lib/material.dart +++ b/packages/flutter/lib/material.dart @@ -4,7 +4,9 @@ /// Flutter widgets implementing Material Design. /// -/// See https://www.google.com/design/spec/material-design/introduction.html +/// See +/// [www.google.com/design/spec/material-design](https://www.google.com/design/spec/material-design/introduction.html) +/// for an introduction to Material Design. library material; export 'src/material/app.dart'; diff --git a/packages/flutter/lib/src/material/icon.dart b/packages/flutter/lib/src/material/icon.dart index 3679f8b1f5..7f18d42a70 100644 --- a/packages/flutter/lib/src/material/icon.dart +++ b/packages/flutter/lib/src/material/icon.dart @@ -6,6 +6,7 @@ import 'package:flutter/widgets.dart'; import 'colors.dart'; import 'icons.dart'; +import 'icon_button.dart'; import 'icon_theme.dart'; import 'theme.dart'; diff --git a/packages/flutter/lib/src/material/icons.dart b/packages/flutter/lib/src/material/icons.dart index ed6ab2a0e3..4c09a62a6b 100644 --- a/packages/flutter/lib/src/material/icons.dart +++ b/packages/flutter/lib/src/material/icons.dart @@ -38,7 +38,7 @@ class IconData { /// /// * [Icon] /// * [IconButton] -/// * +/// * [design.google.com/icons](https://design.google.com/icons/) class Icons { Icons._(); diff --git a/packages/flutter_test/lib/flutter_test.dart b/packages/flutter_test/lib/flutter_test.dart index 27db964486..ae88fd54b0 100644 --- a/packages/flutter_test/lib/flutter_test.dart +++ b/packages/flutter_test/lib/flutter_test.dart @@ -2,7 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -/// Testing library for flutter, built on top of package:test. +/// Testing library for flutter, built on top of `package:test`. library flutter_test; export 'src/instrumentation.dart';