forked from lsegal/yard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ChangeLog
6308 lines (4730 loc) · 259 KB
/
ChangeLog
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
2009-12-15 Loren Segal <lsegal@soen.ca>
* ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump version to 0.5.1
* docs/WhatsNew.md: Update What's New document
* lib/yard/cli/yri.rb, spec/cli/yri_spec.rb: Always put local directory's
.yardoc ahead of cache
* lib/yard/cli/yri.rb, spec/cli/yri_spec.rb: Allow user to specify
~/.yard/yri_search_paths file listing extra yardoc dbs to search. File
format should just be newline separated .yardoc files/directories:
/path/to/.yardoc /path/to/other.yardoc ...
* lib/yard/cli/yardoc.rb: Improve behaviour of re-generating changed objects
during incremental parsing
* lib/yard/registry.rb, lib/yard/registry_store.rb,
spec/registry_store_spec.rb: Change behaviour of RegistryStore loading cache.
Does not load cache on #keys/#values by default. Instead use #load! or
#load_all to load all contents explicitly
* lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Change
behaviour of SourceParser logging
* lib/yard/registry_store.rb: Add cache for failed lookups
* lib/yard/parser/ruby/ruby_parser.rb, spec/parser/ruby/ruby_parser_spec.rb:
Fix RubyParser in 1.9.1p376 (ripper lib was changed)
* lib/yard/registry.rb, spec/registry_spec.rb: Add specs for
Registry.yardoc_file_for_gem
* lib/yard.rb, lib/yard/cli/yri.rb, lib/yard/registry.rb, spec/yard_spec.rb:
Add support for packages named yard-doc-* to be loaded by yri
* Rakefile: Should use RUBY_PLATFORM
2009-12-14 Loren Segal <lsegal@soen.ca>
* ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec: Bump
version to 0.5.0
* lib/yard/parser/c_parser.rb: Add auto-type support for Class in native code
2009-12-13 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yardoc.rb, lib/yard/logging.rb, lib/yard/registry.rb: When
yardoc --use-cache is specified, generate only the objects parsed from
changed files
* lib/yard/cli/yardoc.rb, lib/yard/registry.rb: Update behaviour for
--build-gems, Registry.yardoc_file_for_gem, add --re-build-gems to force
building of all gems
* lib/yard/registry_store.rb: Document RegistryStore
* lib/yard/cli/base.rb: Document CLI::Base
* lib/rubygems_plugin.rb, lib/yard/core_ext/file.rb,
lib/yard/handlers/base.rb, lib/yard/parser/ruby/legacy/ruby_lex.rb,
lib/yard/parser/source_parser.rb: Fix various warnings in ruby -w Closes
gh-55
* lib/yard/core_ext/hash.rb, spec/core_ext/hash_spec.rb: Backport Hash[arr]
1.8.7+ behaviour to 1.8.6
* lib/yard/registry_store.rb, spec/registry_store_spec.rb: Add more specs to
RegistryStore
* lib/yard/parser/source_parser.rb, lib/yard/registry.rb,
spec/parser/source_parser_spec.rb: Move checksum code into
Registry#checksum_for
* lib/yard/cli/yri.rb, spec/cli/yri_spec.rb: Don't cache Registry.yardoc_file
in yri lookups
* lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Add
checking of checksum cache when parsing files
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Streamline merge/cache
options into -c (--use-cache) to reload existing yardoc db and merge the
results. Adding -c will also do incremental parsing on files using against a
SHA1 checksum of the file contents to speed up parse time. TODO: incremental
generation of HTML files.
* lib/yard/registry.rb, lib/yard/registry_store.rb,
lib/yard/serializers/yardoc_serializer.rb, spec/registry_store_spec.rb: Add
loading/saving of RegistryStore#checksums
* lib/yard/parser/c_parser.rb: Add extra types recognition for Array
* lib/yard/parser/c_parser.rb: Improve types recognition for C call-seqs
* spec/templates/examples/method003.html,
spec/templates/examples/method005.html,
spec/templates/examples/module001.html,
templates/default/method_details/setup.rb: Fix source not showing for
overloaded methods
* lib/yard/templates/helpers/html_helper.rb: Fix linking of default return
type in signature
* lib/yard/templates/helpers/html_helper.rb: Properly linkify default return
type
* lib/yard/tags/overload_tag.rb, spec/tags/overload_tag_spec.rb: Fix
OverloadTag when parsing signature starting with 'def'
* lib/yard/parser/c_parser.rb: Improve parsing of native call-seq
2009-12-12 Loren Segal <lsegal@soen.ca>
* spec/templates/examples/method001.html,
spec/templates/examples/method002.html,
spec/templates/examples/method003.html,
spec/templates/examples/method004.html,
spec/templates/examples/method005.html,
templates/default/method/html/header.erb: Fix view source link not showing
for individual method page
* lib/yard/code_objects/class_object.rb, lib/yard/parser/c_parser.rb,
spec/code_objects/class_object_spec.rb,
templates/default/module/html/box_info.erb: Add support for BasicObject class
as parent of Object
* lib/yard/templates/helpers/html_helper.rb,
templates/default/fulldoc/html/setup.rb,
templates/default/layout/html/index.erb,
templates/default/layout/html/setup.rb: Fix displaying of README filenames in
the form README.lang.ext
* lib/yard/serializers/yardoc_serializer.rb: Remove unique object
serialization tricks in YardocSerializer (marshal handles this)
* lib/yard/registry_store.rb, spec/registry_store_spec.rb: Add specs for
RegistryStore#load returning true/false
* lib/yard/registry_store.rb: Registry.load_yardoc should return true if
.yardoc loads
* lib/yard/registry_store.rb, spec/registry_store_spec.rb: Always load root
object first when loading .yardoc
* lib/yard/registry_store.rb: Treat :root and empty string as equivalent in
RegistryStore#get
* lib/yard/handlers/processor.rb, lib/yard/logging.rb,
templates/default/fulldoc/html/setup.rb: Add Logger#backtrace to show
backtraces only if Logger#show_backtraces is set. Enables --backtrace in CLI
classes.
* lib/yard/code_objects/base.rb, lib/yard/code_objects/proxy.rb,
lib/yard/code_objects/root_object.rb, lib/yard/handlers/base.rb,
lib/yard/parser/c_parser.rb, lib/yard/templates/helpers/html_helper.rb,
templates/default/fulldoc/html/full_list.erb,
templates/default/layout/dot/setup.rb,
templates/default/layout/html/breadcrumb.erb,
templates/default/layout/html/index.erb,
templates/default/layout/html/setup.rb,
templates/default/method_details/text/setup.rb,
templates/default/module/html/box_info.erb: Don't test against actual
Registry.root, instead check if object is a RootObject (through #root?)
* lib/yard/code_objects/method_object.rb: Make sure parent of method is a
namespace
* lib/yard/cli/yri.rb: Current path's .yardoc should be first in the search
path for yri
* lib/yard/autoload.rb, lib/yard/cli/base.rb, lib/yard/cli/yard_graph.rb,
lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb: Refactor CLI classes into
subclass of CLI::Base to get common options
2009-12-11 Loren Segal <lsegal@soen.ca>
* lib/yard/docstring.rb, lib/yard/tags/library.rb: Docstring object should
not keep tag factory instance in an instance variable
* lib/yard/serializers/yardoc_serializer.rb: Better dumping on a
StubProxy/CodeObject
* lib/yard/registry_store.rb, lib/yard/serializers/yardoc_serializer.rb: Load
entire yardoc db before calling keys/values
* lib/yard/registry.rb, lib/yard/registry_store.rb: get('') and get(:root)
should both get root object
* lib/yard/serializers/yardoc_serializer.rb: Cache object that StubProxy is
pointing to (saves a lookup) but don't serialize cached object.
* lib/yard/serializers/yardoc_serializer.rb: Minor refactoring
* benchmarks/yri_cache.rb, lib/yard/cli/yri.rb: Add caching to yri with a
benchmark to illustrate speedup results
* lib/yard/registry.rb, spec/registry_spec.rb, spec/registry_store_spec.rb:
Add specs for RegistryStore
* spec/registry_spec.rb: Refactor Registry specs
* lib/yard/templates/helpers/html_helper.rb,
.../helpers/html_syntax_highlight_helper.rb,
.../helpers/html_syntax_highlight_helper18.rb,
spec/templates/helpers/html_helper_spec.rb: Can now opt out of syntax
highlighting on an indented block by putting "!!!plain" alone on the first
line of the block. For example: !!!plain non-ruby code here Also allows
adding support for highlighting multiple languages. The prefix !!!NAME will
call the method "html_syntax_highlight_NAME" with the source. This is how
"!!!ruby" works, for instance. Thanks lriesterer for the initial patch.
2009-12-10 Loren Segal <lsegal@soen.ca>
* lib/yard/handlers/ruby/attribute_handler.rb,
spec/handlers/attribute_handler_spec.rb: Handle attr* call with no arguments
* lib/yard/code_objects/class_object.rb: Fix handling of
ClassObject#superclass
* lib/yard/code_objects/class_object.rb: Fix handling of
ClassObject#superclass
* lib/yard/handlers/ruby/attribute_handler.rb,
spec/handlers/attribute_handler_spec.rb: Handle attr* call with no arguments
* lib/yard/cli/yardoc.rb: Change message for --build-gems
* lib/yard/cli/yri.rb: yri can now use the new .yardoc format for index
* lib/yard/cli/yardoc.rb, lib/yard/registry.rb: Fix --build-gem to use new
.yardoc format for index
2009-12-09 Loren Segal <lsegal@soen.ca>
* spec/parser/source_parser_spec.rb: Fix specs for YARD.parse and directories
* spec/parser/source_parser_spec.rb: Fix specs for YARD.parse and directories
2009-12-08 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb, lib/yard/registry.rb: Add
implementation to write index for YRI. Should be merged into .yardoc /
Registry
* lib/yard.rb, spec/yard_spec.rb: Only load latest version of any Gem plugin
* lib/yard/cli/yri.rb: Add debugging messages to YRI
* lib/yard/cli/yardoc.rb: Add --merge to merge parsed data into existing
.yardoc file (specified with -b)
* lib/yard/cli/yardoc.rb: Add --build-gems to build .yardoc file for gems
* lib/yard/cli/yri.rb, lib/yard/registry.rb: Add Registry.yardoc_file_for_gem
* bin/yri, lib/yard/autoload.rb, lib/yard/cli/yri.rb: Refactor yri bin into
CLI::YRI
* templates/default/fulldoc/html/setup.rb: Handle errors during HTML
generation
* lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Fix call-seq
handling
* lib/yard/code_objects/base.rb: Fix exception being thrown for source with
no spaces
* lib/yard/cli/yardoc.rb: Ignore comments in .document file
* lib/yard/code_objects/base.rb, lib/yard/parser/c_parser.rb,
.../helpers/html_syntax_highlight_helper.rb,
.../helpers/html_syntax_highlight_helper18.rb,
spec/code_objects/base_spec.rb,
templates/default/method_details/html/source.erb: Add
CodeObjects::Base#source_type to set source type (:ruby or :c), only
highlight for Ruby code
2009-12-07 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/c_parser.rb: Add support for one-line call-seq:
* lib/yard/cli/yardoc.rb, lib/yard/parser/source_parser.rb,
spec/cli/yardoc_spec.rb: Add ext/**/*.c to default parse glob
* spec/parser/source_parser_spec.rb: Remove warning spec for C/C++ files
* lib/yard/autoload.rb, lib/yard/parser/c_parser.rb,
lib/yard/parser/source_parser.rb, spec/parser/c_parser_spec.rb,
spec/parser/examples/array.c.txt, spec/spec_helper.rb: Initial C parser
implementation
2009-12-08 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb, lib/yard/registry.rb: Add
implementation to write index for YRI. Should be merged into .yardoc /
Registry
* lib/yard.rb, spec/yard_spec.rb: Only load latest version of any Gem plugin
* lib/yard/cli/yri.rb: Add debugging messages to YRI
* lib/yard/cli/yardoc.rb: Add --merge to merge parsed data into existing
.yardoc file (specified with -b)
* lib/yard/cli/yardoc.rb: Add --build-gems to build .yardoc file for gems
* lib/yard/cli/yri.rb, lib/yard/registry.rb: Add Registry.yardoc_file_for_gem
* bin/yri, lib/yard/autoload.rb, lib/yard/cli/yri.rb: Refactor yri bin into
CLI::YRI
* templates/default/fulldoc/html/setup.rb: Handle errors during HTML
generation
* lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Fix call-seq
handling
* lib/yard/code_objects/base.rb: Fix exception being thrown for source with
no spaces
* lib/yard/cli/yardoc.rb: Ignore comments in .document file
* lib/yard/code_objects/base.rb, lib/yard/parser/c_parser.rb,
.../helpers/html_syntax_highlight_helper.rb,
.../helpers/html_syntax_highlight_helper18.rb,
spec/code_objects/base_spec.rb,
templates/default/method_details/html/source.erb: Add
CodeObjects::Base#source_type to set source type (:ruby or :c), only
highlight for Ruby code
2009-12-07 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/c_parser.rb: Add support for one-line call-seq:
* lib/yard/cli/yardoc.rb, lib/yard/parser/source_parser.rb,
spec/cli/yardoc_spec.rb: Add ext/**/*.c to default parse glob
* spec/parser/source_parser_spec.rb: Remove warning spec for C/C++ files
* lib/yard/autoload.rb, lib/yard/parser/c_parser.rb,
lib/yard/parser/source_parser.rb, spec/parser/c_parser_spec.rb,
spec/parser/examples/array.c.txt, spec/spec_helper.rb: Initial C parser
implementation
2009-12-08 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/source_parser.rb: If a directory is given to YARD.parse,
make it a file glob instead.
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Add better tokenization
support in .yardoc file (support quoted multi-space tokens) You should now
be able to set a long title with: --title "Foo Bar"
* lib/yard/core_ext/string.rb, spec/core_ext/string_spec.rb: Add
String#shell_split to split text into tokens like a shell does (respecting
quoted tokens)
* spec/core_ext/string_spec.rb: Refactor string specifications
2009-12-07 Loren Segal <lsegal@soen.ca>
* spec/templates/examples/class001.html,
spec/templates/examples/method004.html,
spec/templates/examples/method004.txt,
spec/templates/examples/method005.html,
spec/templates/examples/method005.txt, spec/templates/examples/module001.dot,
spec/templates/examples/module001.html,
spec/templates/examples/module001.txt, spec/templates/module_spec.rb: Correct
all template specs
* lib/yard/templates/helpers/html_helper.rb: Only show overload as signature
if there is one overload
* lib/yard/tags/overload_tag.rb: Improve robustness of OverloadTag signature
parsing
* templates/default/tags/html/overload.erb: Don't show empty overload
sections
* lib/yard/templates/helpers/method_helper.rb,
spec/templates/helpers/method_helper_spec.rb: Show yield block in signature
for method with no params
* lib/yard/templates/helpers/method_helper.rb,
templates/default/method_details/setup.rb: Add extra robustness for method
with no source attached
* lib/yard/templates/helpers/html_helper.rb: htmlify method names in
signature
* lib/yard/templates/helpers/html_helper.rb: Fix typewriter text for
unmatched ++
* lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,
lib/yard/templates/helpers/text_helper.rb, spec/cli/yardoc_spec.rb,
spec/templates/helpers/html_helper_spec.rb,
.../templates/helpers/shared_signature_examples.rb,
spec/templates/helpers/text_helper_spec.rb: Revert hiding of (Object) and
(void) return types in signature by default, but add switches to re-enable
the behaviour. New switches are --default-return and --hide-void-return.
--default-return can take the empty string to show no return type. Also port
behaviour over to text_helper.rb and refactor specs to test both helpers at
the same time.
* lib/yard/code_objects/method_object.rb: Better handling of methods in proxy
namespaces.
* lib/yard/code_objects/base.rb: Fix method match for #<=>
2009-12-06 Loren Segal <lsegal@soen.ca>
* lib/yard/tags/overload_tag.rb: Fix OverloadTag#name for instance methods
* lib/yard/tags/overload_tag.rb,
spec/serializers/file_system_serializer_spec.rb,
spec/tags/overload_tag_spec.rb, spec/templates/examples/module001.html,
spec/templates/helpers/html_helper_spec.rb: Fix the way object lookups are
done inside overload tags. Closes gh-51
* lib/yard/code_objects/base.rb, spec/templates/helpers/base_helper_spec.rb:
Change the way Base#=== tests equality (call #is_a? on other)
* spec/serializers/file_system_serializer_spec.rb: Refactor
FileSystemSerializer specs
2009-12-05 Loren Segal <lsegal@soen.ca>
* templates/default/module/setup.rb: Fix sort_listing for Ruby1.8
* templates/default/module/setup.rb: Refactor method listing behaviour for
special methods
* templates/default/module/html/item_summary.erb: Only show constructor note
inside a class
* lib/yard/code_objects/method_object.rb,
spec/code_objects/method_object_spec.rb: Only show #initialize as constructor
if defined in a class
* templates/default/module/setup.rb: Only sort method summary by scope/name,
not visibility
* lib/yard/code_objects/method_object.rb,
spec/code_objects/method_object_spec.rb: Add MethodObject#constructor? to
return if method is #initialize
* lib/yard/templates/helpers/html_helper.rb,
lib/yard/templates/helpers/method_helper.rb,
spec/templates/helpers/html_helper_spec.rb,
spec/templates/helpers/method_helper_spec.rb: Show multiple types in
signature return types and add heuristics for nullable/splat returns Summary
of the new heuristics are as follows: * Single return type: (Type) * Two
return types: (TypeA, TypeB) * More than two: (TypeA, ...) * @return [Type,
nil]: (Type?) [? is superscripted] * @return [Type, Array<Type>]: (Type+) [+
is superscripted] * @return [void]: no return type shown Closes gh-49
* spec/templates/examples/method003.html,
templates/default/tags/html/overload.erb: Don't show extra text in overload
signatures
* templates/default/fulldoc/html/css/style.css: Display paragraphs as block
elements in overload tags Closes gh-50
2009-12-04 Loren Segal <lsegal@soen.ca>
* lib/yard/handlers/ruby/legacy/method_handler.rb,
lib/yard/handlers/ruby/method_handler.rb, lib/yard/tags/tag.rb,
spec/handlers/examples/method_handler_001.rb.txt,
spec/handlers/method_handler_spec.rb: Add @return [Boolean] to methods ending
in '?' unless they have a return type set
* spec/templates/examples/class001.html,
spec/templates/examples/method001.html,
spec/templates/examples/method002.html,
spec/templates/examples/method002.txt,
spec/templates/examples/method003.html,
spec/templates/examples/method003.txt,
spec/templates/examples/method004.html,
spec/templates/examples/method004.txt,
spec/templates/examples/method005.html,
spec/templates/examples/method005.txt, spec/templates/examples/module001.dot,
spec/templates/examples/module001.html,
spec/templates/examples/module001.txt, spec/templates/method_spec.rb,
spec/templates/module_spec.rb, spec/templates/spec_helper.rb: Add tests for
void return types and overloaded attributes
* lib/yard/templates/helpers/text_helper.rb: Fix signature for text helper
(don't show return for void/undocumented meths)
* templates/default/fulldoc/html/css/style.css,
templates/default/module/html/item_summary.erb: Add constructor button next
to #initialize method in summary
* templates/default/docstring/html/returns_void.erb,
templates/default/docstring/setup.rb,
templates/default/docstring/text/returns_void.erb,
templates/default/fulldoc/html/css/style.css,
templates/default/tags/setup.rb: Don't show @return for void, but show note
in a void method
* lib/yard/cli/yardoc.rb, lib/yard/code_objects/base.rb,
lib/yard/code_objects/class_object.rb, lib/yard/code_objects/proxy.rb,
lib/yard/core_ext/symbol_hash.rb, lib/yard/handlers/base.rb,
lib/yard/handlers/processor.rb, lib/yard/parser/ruby/ast_node.rb,
lib/yard/parser/source_parser.rb, lib/yard/rake/yardoc_task.rb,
lib/yard/registry.rb, lib/yard/serializers/base.rb,
lib/yard/templates/engine.rb, lib/yard/verifier.rb: Documentation: change to
@return [void] instead of [nil]
* lib/yard/templates/helpers/html_helper.rb: Don't show return type if none
specified or void
* lib/yard/handlers/ruby/legacy/method_handler.rb,
lib/yard/handlers/ruby/method_handler.rb,
spec/handlers/method_handler_spec.rb: #initialize should return [void]
* lib/yard/templates/helpers/html_helper.rb: Use first @overload tag for
return type in signature if no other return tag is present
* templates/default/fulldoc/html/setup.rb: Add attributes to method listing
* lib/yard/tags/overload_tag.rb, spec/handlers/method_handler_spec.rb: Allow
@overload to change name in signature
* lib/yard/code_objects/method_object.rb,
spec/code_objects/method_object_spec.rb: Fix MethodObject#is_attribute? when
attr exists but not for both read/write Closes gh-48
* spec/templates/examples/class001.html,
spec/templates/examples/module001.html,
.../default/class/html/constructor_details.erb,
templates/default/fulldoc/html/js/app.js,
.../default/module/html/attribute_details.erb,
.../default/module/html/attribute_summary.erb,
.../default/module/html/method_details_list.erb,
templates/default/module/html/method_summary.erb,
templates/default/module/html/methodmissing.erb,
templates/default/module/setup.rb: Split attr/method summary/details by into
separate class/instance sections
2009-12-01 Loren Segal <lsegal@soen.ca>
* lib/yard/templates/helpers/html_helper.rb: Sort tag attributes so tests can
pass across 1.8/1.9 without modification
* lib/yard.rb: Remove Encoding declaration (breaks in 1.9 and isn't
necessary)
* lib/yard/tags/overload_tag.rb, spec/templates/examples/module001.dot,
spec/templates/examples/module001.html,
spec/templates/examples/module001.txt, spec/templates/module_spec.rb,
templates/default/docstring/setup.rb,
templates/default/module/html/item_summary.erb: Fix duplicate docstring for
single @overload tag. Also add overloaded signature to method summary listing
in this case. Closes gh-39
2009-12-01 postmodern <postmodern.mod3@gmail.com>
* templates/default/fulldoc/html/css/style.css: Used a unicode hex-escape
sequence in the CSS instead.
2009-12-01 Loren Segal <lsegal@soen.ca>
* lib/yard.rb: Force UTF-8 encoding for templates and files. Closes gh-47
* templates/default/method/html/header.erb,
templates/default/module/html/defines.erb: Fix 1.8.6 incompatibility issue
(missing Symbol#to_proc)
* spec/templates/examples/method001.html,
spec/templates/examples/module001.html,
.../method_details/html/method_signature.erb: Permalink aliases Closes gh-44
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
.../default/module/html/inherited_constants.erb,
.../default/module/html/inherited_methods.erb: Hide private inherited
methods/constants. Closes gh-43
* lib/yard/handlers/ruby/attribute_handler.rb,
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
lib/yard/handlers/ruby/legacy/method_handler.rb,
lib/yard/handlers/ruby/method_handler.rb,
spec/handlers/method_handler_spec.rb, spec/templates/examples/class001.html,
spec/templates/examples/module001.html: Remove RDoc specific markup for
auto-generated meta-tags. Closes gh-45
2009-11-29 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/setup.rb, templates/default/module/setup.rb:
Ignore @private classes/modules. Closes gh-46
2009-11-26 Loren Segal <lsegal@soen.ca>
* lib/yard/handlers/base.rb: Add no-continuation warning for Rubinius and
only warn once
2009-11-21 Loren Segal <lsegal@soen.ca>
* lib/yard/core_ext/module.rb, spec/core_ext/module_spec.rb: Resolve
collision with Module#namespace and Rake, renamed to #namespace_name Closes
gh-42
2009-11-17 Loren Segal <lsegal@soen.ca>
* templates/default/layout/html/index.erb: Sort index listing in 1.8
2009-11-16 Loren Segal <lsegal@soen.ca>
* templates/default/module/dot/info.erb: Fix broken dot template in Ruby1.8
(due to hash ordering)
* lib/yard/parser/ruby/legacy/statement_list.rb,
spec/parser/source_parser_spec.rb: Legacy parser should prioritize prepended
comments over appended ones. Closes gh-38
2009-11-15 Loren Segal <lsegal@soen.ca>
* .../helpers/html_syntax_highlight_helper.rb,
.../helpers/html_syntax_highlight_helper18.rb: Add sanity checks for methods
with no source
* lib/yard/templates/helpers/method_helper.rb: Sanity check for methods with
no source
* ChangeLog, lib/yard.rb, yard.gemspec: Bump version to 0.4.0
* ChangeLog: Update changelog
* lib/yard/handlers/ruby/legacy/constant_handler.rb: Fix constant missing
error
* lib/yard/templates/helpers/module_helper.rb: Fix prune_method_listing to
work more gracefully with methods in proxy namespaces
* spec/templates/helpers/base_helper_spec.rb,
templates/default/layout/html/footer.erb, yard.gemspec: Change URL to
yardoc.org
2009-11-14 Loren Segal <lsegal@soen.ca>
* lib/yard/templates/template.rb: Allow superb to specify a section name
2009-11-13 Loren Segal <lsegal@soen.ca>
* Rakefile: Only build .gem for install
* Rakefile: Allow rake to function without RSpec
* spec/templates/examples/class001.html,
spec/templates/examples/class001.txt, spec/templates/examples/module001.dot,
spec/templates/examples/module001.html: Update template specs
2009-11-12 Loren Segal <lsegal@soen.ca>
* lib/yard/handlers/ruby/constant_handler.rb: Remove unneeded Registry check
in constant handler
* README.md: Document new features in changelog section
* lib/yard.rb, spec/yard_spec.rb: Use Gem.source_index.entries instead of
all_gems (Rails compatibility) Closes gh-36
* lib/yard/core_ext/string.rb, spec/core_ext/string_spec.rb: Make
String#underscore behave like activesupport's (Rails compatibility) Closes
gh-35
2009-11-11 Loren Segal <lsegal@soen.ca>
* lib/yard/handlers/ruby/class_handler.rb,
lib/yard/handlers/ruby/constant_handler.rb,
lib/yard/handlers/ruby/legacy/constant_handler.rb,
lib/yard/parser/ruby/ast_node.rb, spec/handlers/constant_handler_spec.rb,
spec/handlers/examples/class_handler_001.rb.txt,
spec/handlers/examples/constant_handler_001.rb.txt,
spec/parser/ruby/ruby_parser_spec.rb: Add support for X =
Struct.new(:attrname, ...) class declaration syntax
2009-11-07 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/css/full_list.css,
templates/default/fulldoc/html/css/style.css: IE7 compatibility fixes
* lib/yard/parser/ruby/ruby_parser.rb, spec/parser/ruby/ruby_parser_spec.rb:
Fix AstNode handling for source of array references and if/unless/while
statements
* bin/view_generator: Remove old view_generator test binary
2009-11-06 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/ruby/legacy/statement_list.rb,
spec/parser/ruby/legacy/statement_list_spec.rb: Another fix for comments not
registering as docstrings in 1.8 parser
* lib/yard/parser/ruby/legacy/statement_list.rb,
spec/parser/ruby/legacy/statement_list_spec.rb: Fix behaviour in legacy
parser for which comments should be associated with a statement
* lib/yard/handlers/ruby/class_handler.rb,
spec/handlers/class_handler_spec.rb,
spec/handlers/examples/class_handler_001.rb.txt: Fix docstring being
destroyed in 1.9 parser when a class is redefined without comments
2009-11-05 Loren Segal <lsegal@soen.ca>
* docs/GettingStarted.md: Add plugin info to getting started guide
* lib/yard/code_objects/base.rb, lib/yard/code_objects/method_object.rb,
spec/code_objects/method_object_spec.rb,
templates/default/fulldoc/html/full_list.erb,
templates/default/layout/html/breadcrumb.erb,
templates/default/module/setup.rb: Add name(prefix=false) to
CodeObjects::Base to simplify API for calling methobj.name(true)
* lib/yard/templates/helpers/html_helper.rb: Add special title for link in
signature
* yard.gemspec: Add changelog to gemspec
* lib/yard/code_objects/class_variable_object.rb,
lib/yard/handlers/ruby/class_variable_handler.rb,
.../handlers/ruby/legacy/class_variable_handler.rb,
lib/yard/templates/helpers/html_helper.rb,
spec/handlers/class_variable_handler_spec.rb, spec/templates/module_spec.rb,
templates/default/module/setup.rb: Add class variables to templates along
with constants
* lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Try to
parse toplevel files first
* templates/default/fulldoc/html/setup.rb: Make title more obvious that it's
YARD parsing the docs, not YARD's docs.
* .../handlers/ruby/legacy/class_variable_handler.rb,
.../examples/class_variable_handler_001.rb.txt: Parse class variable name
properly in 1.8 parser
* lib/yard/handlers/ruby/exception_handler.rb,
.../handlers/examples/exception_handler_001.rb.txt,
spec/handlers/exception_handler_spec.rb: Ignore 'raise' called on target
receivers in 1.9 parser
2009-11-04 Loren Segal <lsegal@soen.ca>
* templates/default/class/setup.rb,
templates/default/module/html/box_info.erb,
.../default/module/html/inherited_constants.erb,
.../default/module/html/inherited_methods.erb,
templates/default/module/setup.rb: Sort various method/child/subclass lists
* .yardopts, ChangeLog: Update changelog, put it in docs
* docs/GettingStarted.md, docs/WhatsNew.md: Fix some broken links to old
README.markdown
2009-11-03 Loren Segal <lsegal@soen.ca>
* benchmarks/template_profile.rb: Don't use perftools
* lib/yard/templates/template.rb: Make example more realistic
* benchmarks/concat_vs_join.rb, benchmarks/erb_vs_erubis.rb,
benchmarks/pathname_vs_string.rb, benchmarks/template_erb.rb,
benchmarks/template_format.rb, benchmarks/template_profile.rb: Add/update
benchmarks for templates
* lib/yard/core_ext/file.rb, lib/yard/templates/engine.rb,
lib/yard/templates/template.rb, spec/core_ext/file_spec.rb,
spec/templates/engine_spec.rb, spec/templates/template_spec.rb: Remove
Pathname from code, it is too slow.
* lib/yard/templates/template.rb: Refactor erb to use erb_with and only trim
newlines if format == text (performance)
* templates/default/fulldoc/html/css/style.css: Fix constant colour in syntax
highlighting
* templates/default/fulldoc/html/css/full_list.css: Make search box in
namespace list rounded, collapse border
* lib/yard/templates/helpers/html_helper.rb,
spec/templates/helpers/html_helper_spec.rb: format_types should work for
composite paths (A::B)
2009-11-02 Loren Segal <lsegal@soen.ca>
* README.md: Update readme
* lib/yard/code_objects/class_object.rb: Fix broken @see reference
* docs/WhatsNew.md: Add more info on updated templates
* lib/yard/tags/library.rb, templates/default/docstring/html/note.erb,
templates/default/docstring/html/todo.erb,
templates/default/docstring/setup.rb,
templates/default/docstring/text/note.erb,
templates/default/docstring/text/todo.erb,
templates/default/fulldoc/html/css/style.css: Add @note, add @note and @todo
into templates
* lib/yard/code_objects/base.rb: Explain how to modify
CodeObjects::Base#files
* lib/yard/docstring.rb, spec/docstring_spec.rb: Don't end summary in the
middle of a decimal (like 1.5)
* templates/default/layout/html/footer.erb,
templates/default/layout/html/header.erb,
templates/default/layout/html/headers.erb,
templates/default/layout/html/layout.erb,
templates/default/layout/html/search.erb,
templates/default/layout/html/setup.rb: Split layout template into sections
* lib/yard.rb: Remove modification
* docs/WhatsNew.md: Document new plugin ignore behaviour
* lib/yard.rb, spec/yard_spec.rb: Add mechanism to ignore plugins by name
(add names to ~/.yard/ignored_plugins)
* lib/yard.rb: Debug needs to be modified or debugging message does not show
* lib/yard.rb: Documentation for a few helper methods
* lib/yard.rb, spec/yard_spec.rb: Add plugin support. Name your gems
'yard-myplugin' or 'yard_myplugin'. Plugins are loaded automatically when
YARD loads. The '-' separator is the recommended naming scheme.
* docs/WhatsNew.md: Document the plugin behaviour
* lib/yard.rb, spec/yard_spec.rb: Add plugin support. Name your gems
'yard-myplugin' or 'yard_myplugin'. Plugins are loaded automatically when
YARD loads. The '-' separator is the recommended naming scheme.
* lib/yard/handlers/base.rb, lib/yard/templates/template.rb: Remove a few
debugging messages (too much info)
* lib/yard/code_objects/constant_object.rb,
lib/yard/handlers/ruby/legacy/constant_handler.rb,
spec/handlers/constant_handler_spec.rb,
spec/handlers/examples/constant_handler_001.rb.txt: Fix constants removing
newlines from value in 1.8
2009-11-01 Loren Segal <lsegal@soen.ca>
* lib/yard/templates/helpers/html_helper.rb,
spec/templates/helpers/html_helper_spec.rb: Fix format_types to link all
words
* templates/default/class/setup.rb: Improve rendering speed of subclasses
section
* lib/yard/handlers/ruby/legacy/method_handler.rb,
lib/yard/handlers/ruby/method_handler.rb,
spec/handlers/examples/method_handler_001.rb.txt,
spec/handlers/method_handler_spec.rb: Add Class.inherited to privatized
method list
* templates/default/fulldoc/html/setup.rb: Refactor logic to generate
index.html file, do so for readme or table of contents
* lib/yard/code_objects/base.rb: Document CodeObjects::Base as abstract
* docs/GettingStarted.md, docs/Templates.md, docs/WhatsNew.md,
templates/default/fulldoc/html/css/style.css: Update documentation, discuss
new features
* templates/default/fulldoc/html/css/style.css: Use the same font family as
signature
* templates/default/fulldoc/html/css/style.css: Alias name should be smaller
in signature
* lib/yard/templates/engine.rb, lib/yard/templates/template.rb,
spec/templates/engine_spec.rb: Fix inclusion order of overriden templates
* spec/templates/examples/class001.html,
spec/templates/examples/method001.html,
spec/templates/examples/method002.html,
spec/templates/examples/method003.html,
spec/templates/examples/module001.html, spec/templates/examples/tag001.txt,
spec/templates/helpers/html_helper_spec.rb: Update specs
* spec/cli/yardoc_spec.rb: Fix broken spec due to README being renamed
* lib/yard/handlers/ruby/legacy/yield_handler.rb,
lib/yard/handlers/ruby/yield_handler.rb, spec/handlers/yield_handler_spec.rb,
templates/default/tags/html/tag.erb, templates/default/tags/setup.rb: Show
yield types iff there are types present
* templates/default/fulldoc/html/css/style.css: Update css
* lib/yard/code_objects/base.rb, lib/yard/docstring.rb,
lib/yard/handlers/ruby/legacy/base.rb: Fix broken reference links
* lib/yard/templates/helpers/html_helper.rb,
templates/default/fulldoc/html/css/style.css,
templates/default/module/html/item_summary.erb: Add info bubbles to summaries
* .yardopts, Rakefile: Move some options to yardopts
* templates/default/fulldoc/html/css/style.css,
templates/default/layout/html/header.erb,
.../default/module/html/attribute_summary.erb,
templates/default/module/html/header.erb,
templates/default/module/html/item_summary.erb,
templates/default/module/html/method_summary.erb,
templates/default/module/setup.rb: Add abstract/deprecated info bubbles
* templates/default/fulldoc/html/css/style.css: Links in summary descriptions
should be smaller
* templates/default/fulldoc/html/css/full_list.css,
templates/default/fulldoc/html/css/style.css,
templates/default/fulldoc/html/js/app.js,
.../default/module/html/attribute_summary.erb,
templates/default/module/html/method_summary.erb: Update css, make
method/attr summaries more apparent
* templates/default/docstring/html/abstract.erb,
templates/default/docstring/html/deprecated.erb,
templates/default/fulldoc/html/css/style.css,
templates/default/method_details/html/header.erb: Prettify method headers
* templates/default/fulldoc/html/css/style.css: h3,h4 font sizes are too
small for dotted border. Use whitespace instead
* templates/default/fulldoc/html/css/style.css: Update css for page title /
index page
* templates/default/fulldoc/html/setup.rb,
templates/default/layout/html/index.erb,
templates/default/layout/html/setup.rb: Update page title and index page
behaviour
* Rakefile: Add title to rake yard
* Rakefile, lib/yard/autoload.rb: Add @private tags and use --no-private
* yard.gemspec: Update gemspec (renamed readme)
* templates/default/fulldoc/html/css/style.css: Align source code line
numbers to right
* templates/default/fulldoc/html/css/style.css,
templates/default/module/html/box_info.erb,
templates/default/module/html/constant_summary.erb: Make HTML valid, update
css
* templates/default/layout/html/header.erb,
templates/default/module/html/defines.erb: Fix html errors
* templates/default/fulldoc/html/css/full_list.css,
templates/default/fulldoc/html/css/style.css,
templates/default/fulldoc/html/js/app.js,
templates/default/fulldoc/html/js/full_list.js,
templates/default/layout/html/breadcrumb.erb,
templates/default/layout/html/header.erb,
templates/default/layout/html/index.erb: Update css, js
2009-10-31 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/css/style.css,
templates/default/fulldoc/html/setup.rb,
templates/default/layout/html/breadcrumb.erb,
templates/default/layout/html/glossary.erb,
templates/default/layout/html/index.erb,
templates/default/layout/html/setup.rb: Rename glossary as Alphabetic Index
page
* lib/yard/templates/helpers/html_helper.rb: Fix broken formatting
* docs/Templates.md: Fix code block
* .yardopts, README.markdown, README.md, docs/FAQ.md: Rename README, remove
FAQ
* docs/WhatsNew.md: Update what's new for next release
* README.markdown: Document new --query parameter
* lib/yard/templates/helpers/html_helper.rb: Fix problem with fix_typewriter
and document some methods
* lib/yard/templates/template.rb: Fix invalid reference
* README.markdown, docs/GettingStarted.md: Update docs to reflect new YARD
behaviours
* lib/yard/templates/template.rb: Update documentation
* spec/templates/template_spec.rb: Test superb from erb
2009-10-30 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/setup.rb: Allow overriding of assets with
{{{__super__}}} inside subclassed template assets
* lib/yard/templates/template.rb, spec/templates/template_spec.rb: Add
Template#superb and modify Template#file to allow insertion of inherited