forked from lsegal/yard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ChangeLog
7189 lines (5359 loc) · 293 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
2010-06-21 Loren Segal <lsegal@soen.ca>
* ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump to version 0.5.7
2010-06-17 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yardoc.rb, lib/yard/serializers/file_system_serializer.rb,
spec/cli/yardoc_spec.rb: Clean up parsing of yardoc options and handle
.document files more effectively
* README.md: Add special installation instructions for some Ubuntu/Debian
installations. It is impossible to add rdoc as a dependency, since this will
force the RDoc gem to be installed rather than the Ruby stdlib package. It is
therefore preferable to install rdoc locally with apt-get on such an OS.
Closes gh-109
2010-06-16 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/ruby/ruby_parser.rb: Don't undef 'on_bodystmt'
* lib/yard/cli/yardoc.rb: Add Yardoc#parse_arguments method to perform all
argument parsing (from CLI,.yardopts,.document) at once
* lib/yard/registry_store.rb, lib/yard/serializers/yardoc_serializer.rb:
Improve StubProxy to implement #hash which removes need for TemporaryObject
hack
* spec/verifier_spec.rb: Add spec for Verifier
* lib/yard/verifier.rb: Force updating of Verifier
* templates/default/module/html/item_summary.erb: Show full method name with
"=" suffix in method summary listing
* lib/yard/parser/source_parser.rb: Add documentation for
SourceParser.parser_types
* docs/Parser.md, docs/images/parser-class-diagram.png: Update Parser
Architecture documentation Closes gh-137
* lib/yard/registry.rb: Update Registry documentation Closes gh-136
* lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb:
Support list of regex in registered file extensions for parser type (instead
of a single Regexp)
* lib/yard/parser/source_parser.rb: Document parser_type_extensions as
@private attr
2010-06-15 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Hide methods inside a
@private class if --no-private is used.
* templates/default/tags/text/example.erb: Don't wrap example code in yri.
Wrapping would just cause confusion. Closes gh-71
* lib/yard/cli/yardoc.rb, lib/yard/verifier.rb, spec/cli/yardoc_spec.rb,
spec/verifier_spec.rb: Fix --private and other visibility flags when
specified in .yardopts file. The following changes were made to make this
possible: - Generate verifier for visibilities after option parsing is
finished. - Add Verifier#add_expressions and Verifier#expressions to allow
manipulation of Verifier expressions after it is created. Modifying
expressions will recompile the verifier object. Closes gh-142
* lib/yard/cli/yard_graph.rb: Update default options documentation for
YardGraph
* lib/yard/code_objects/base.rb, lib/yard/code_objects/proxy.rb,
lib/yard/code_objects/root_object.rb, lib/yard/registry_store.rb,
spec/registry_spec.rb, spec/serializers/data/serialized_yardoc/checksums,
.../data/serialized_yardoc/objects/Foo.dat,
.../data/serialized_yardoc/objects/Foo/bar_i.dat,
.../data/serialized_yardoc/objects/Foo/baz_i.dat,
.../data/serialized_yardoc/objects/root.dat,
.../serializers/data/serialized_yardoc/proxy_types,
spec/serializers/yardoc_serializer_spec.rb: Improve equality checking on
CodeObjects and add #hash/#equal? methods Closes gh-119
* lib/yard/registry.rb, spec/registry_spec.rb: Fix "cannot resolve link"
warnings for --incremental Closes gh-70
2010-06-13 Loren Segal <lsegal@soen.ca>
* lib/yard/tags/overload_tag.rb: Only override #to_a in 1.9.x
* lib/yard/tags/overload_tag.rb: 1.9.2 compatibility fix: add #to_ary and
#to_a implementations for splatting a delegate class
* lib/yard/code_objects/proxy.rb: 1.9.2 compatibility fix: re-implement fix
for #to_ary in Proxy in a cleaner way
* spec/parser/c_parser_spec.rb: 1.9.2 compatibility fix: require
'continuation' for CParser spec, since it is not required anywhere else
* spec/handlers/ruby/legacy/base_spec.rb: 1.9.2 compatibility fix: workaround
for RSpec not removing metaprogrammed class after test
* lib/yard/code_objects/proxy.rb: 1.9.2 compatibility fix: add #to_str as
alias for #path
* lib/yard/code_objects/proxy.rb: 1.9.2 compatibility fix: handle #to_ary
calls on Proxy class for #flatten in 1.9.2
* spec/handlers/ruby/base_spec.rb: 1.9.2 compatibility fix: name resolution
behaves differently
* lib/yard/templates/helpers/html_helper.rb: Fix handling of "!!!lang" code
block prefix for RDoc markup
* lib/yard/parser/c_parser.rb: Fix parsing of call-seq in .c files Closes
gh-135
2010-06-12 Loren Segal <lsegal@soen.ca>
* ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec: Release
0.5.6
* lib/rubygems_plugin.rb: Don't generate yri index if has_rdoc == false
* lib/yard/handlers/ruby/class_condition_handler.rb,
spec/handlers/class_condition_handler_spec.rb: Fix failing class condition
handling case in 1.9
* lib/rubygems_plugin.rb, lib/yard/cli/yardoc.rb,
lib/yard/code_objects/base.rb, lib/yard/code_objects/class_object.rb,
lib/yard/code_objects/constant_object.rb,
lib/yard/code_objects/method_object.rb,
lib/yard/code_objects/namespace_object.rb, lib/yard/code_objects/proxy.rb,
lib/yard/docstring.rb, lib/yard/handlers/base.rb,
lib/yard/parser/ruby/ast_node.rb, lib/yard/parser/ruby/ruby_parser.rb,
lib/yard/serializers/file_system_serializer.rb,
lib/yard/tags/default_factory.rb, lib/yard/tags/library.rb,
lib/yard/templates/template.rb, templates/default/tags/html/option.erb: Fix a
boatload of Ruby warnings
* lib/rubygems_plugin.rb: Fix warnings in RubyGems plugin Closes gh-108
* spec/cli/yardoc_spec.rb: Fix Yardoc CLI specs for new read_binary encoding
fixes
* lib/yard/autoload.rb, lib/yard/parser/base.rb, lib/yard/parser/c_parser.rb,
lib/yard/parser/ruby/legacy/ruby_parser.rb,
lib/yard/parser/ruby/legacy/statement_list.rb,
lib/yard/parser/ruby/ruby_parser.rb, lib/yard/parser/source_parser.rb,
spec/parser/base_spec.rb, spec/parser/source_parser_spec.rb: Refactor
SourceParser and create API to extend YARD with custom source parsers using
YARD::Parser::SourceParser.register_parser_type Closes gh-101
2010-06-11 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/source_parser.rb: Add .cc as C source filename extension
* .../ruby/legacy/class_condition_handler.rb,
spec/handlers/class_condition_handler_spec.rb: Fixes handling of class
conditionals in the form "defined?(A) && defined?(B)"
2010-06-05 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yardoc.rb, lib/yard/templates/erb_cache.rb,
lib/yard/templates/helpers/html_helper.rb,
templates/default/layout/html/setup.rb: Various encoding related template
fixes. Closes gh-131
2010-05-26 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yri.rb: Don't use less on Windows (non-cygwin)
* lib/yard/cli/yri.rb: yri should fail gracefully when no arguments are
supplied
* Rakefile: Better rake support for windows
* lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Fix
handling of docstrings in 1.9 parser when there are comments before and on
the same line of a code object
* README.md, docs/GettingStarted.md, docs/Tags.md: Move tag list from
GettingStarted to Tags and document syntax
* README.md: Update README formatting
2010-05-25 Loren Segal <lsegal@soen.ca>
* lib/yard/autoload.rb, lib/yard/handlers/ruby/class_handler.rb,
lib/yard/handlers/ruby/legacy/class_handler.rb,
lib/yard/handlers/ruby/struct_handler_methods.rb: Various documentation and
style refactorings
2010-05-22 Loren Segal <lsegal@soen.ca>
* README.md: Fix release date/version in readme
* README.md: Fix contributors formatting in readme for github
* ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump version to 0.5.5
2010-05-21 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Clean
path names when parsing source files Closes gh-129
2010-05-10 Michael Edgar <michael.j.edgar@dartmouth.edu>
* 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: Auto-generate parameters referred to by
@option tags. Closes gh-16
* lib/yard/docstring.rb, spec/docstring_spec.rb: Resolve reftags the same way
as normal references Closes gh-14
2010-05-21 Loren Segal <lsegal@soen.ca>
* lib/yard/code_objects/base.rb, lib/yard/code_objects/proxy.rb: Remove #hash
implementation due to weird Registry reloading side effects
* lib/yard/tags/default_factory.rb, spec/tags/default_factory_spec.rb: Type
list in tag text should only be listed at the beginning or after first token.
Closes gh-120
* templates/default/module/html/box_info.erb,
templates/default/module/text/extends.erb: Rename "Extends" to "Extended by"
for class mixins in templates. Closes gh-110
* lib/yard/templates/helpers/html_helper.rb: Revert automatic typewriter
textifying of links
* lib/yard/templates/helpers/base_helper.rb,
lib/yard/templates/helpers/html_helper.rb,
spec/templates/examples/class001.html,
spec/templates/helpers/base_helper_spec.rb,
spec/templates/helpers/html_helper_spec.rb,
templates/default/tags/html/see.erb: Refactor #resolve_links into #linkify to
handle 'file:' and URL links more consistently across templates. Closes
gh-121
* lib/yard/code_objects/module_object.rb,
spec/code_objects/module_object_spec.rb: Fix mixins listing twice for
#inheritance_tree on module objects
2010-05-21 wycats <wycats@gmail.com>
* lib/yard/code_objects/base.rb, lib/yard/code_objects/class_object.rb,
lib/yard/code_objects/proxy.rb, spec/code_objects/class_object_spec.rb: Fixes
an issue where mixins could appear twice in the class hierarchy
2010-05-18 Michael Edgar <michael.j.edgar@dartmouth.edu>
* lib/yard/handlers/ruby/struct_handler_methods.rb: Made struct handler
directly add tags. Technical faux pas.
2010-05-15 postmodern <postmodern.mod3@gmail.com>
* lib/yard.rb: Only glob .rb files from yard/core_ext and do not strip the
.rb file extension. * By globbing all files within yard/core_ext, this was
triggering a bug on Rubinius 1.0. Rubinius likes to store compiled Ruby files
(.rbc) along with the Ruby source files (.rb).
http://github.com/evanphx/rubinius/issues/#issue/305
2010-05-15 Loren Segal <lsegal@soen.ca>
* .../ruby/legacy/class_condition_handler.rb,
spec/handlers/class_condition_handler_spec.rb: Implement
ClassConditionHandler for legacy parser. Closes gh-114
* lib/yard/parser/ruby/legacy/statement_list.rb,
spec/parser/ruby/legacy/statement_list_spec.rb: Fill .block for 'else' and
'elsif' statements in legacy parser.
2010-05-09 Michael Edgar <michael.j.edgar@dartmouth.edu>
* lib/yard/handlers/ruby/legacy/class_handler.rb,
spec/handlers/class_handler_spec.rb,
spec/handlers/examples/class_handler_001.rb.txt: Added more specs for
attr_reader and attr_writer combinations.
* lib/yard/handlers/ruby/struct_handler_methods.rb,
spec/handlers/class_handler_spec.rb,
spec/handlers/examples/class_handler_001.rb.txt: Added some specs for the use
of attr_reader and attr_writer. Made them pass.
* lib/yard/handlers/ruby/struct_handler_methods.rb, lib/yard/tags/library.rb:
Added basic logic for the separation of reader/writer attributes. Specs pass,
but no new specs have been added.
* lib/yard/handlers/ruby/class_handler.rb,
lib/yard/handlers/ruby/legacy/class_handler.rb: Added support on the handler
side for defining constants for non-anonymous structs
* spec/handlers/class_handler_spec.rb: Added a spec to ensure that when a
non-anonymous struct is used, the appropriate constant is defined in
Struct::.
* lib/yard/handlers/ruby/class_handler.rb,
lib/yard/handlers/ruby/legacy/class_handler.rb: Added Ruby 1.8.x
compatibility, and fixed an error caused by OStruct.new (without parens).
* lib/yard/handlers/ruby/struct_handler_methods.rb, lib/yard/tags/library.rb,
spec/handlers/class_handler_spec.rb,
spec/handlers/examples/class_handler_001.rb.txt: Specifications added for the
@attr tag.
* lib/yard/handlers/ruby/class_handler.rb: Added basic support for
subclass-syntax with Structs. The newly-added specs pass.
* lib/yard/autoload.rb, lib/yard/handlers/ruby/struct_handler_methods.rb:
Added my struct_handler_methods.rb file from yard-struct, which will provide
shortcuts for adding attributes. This is a module (and not dropped into the
ClassHandler) because I want to reuse this code for the Constant-assignment
syntax as well.
* spec/handlers/class_handler_spec.rb,
spec/handlers/examples/class_handler_001.rb.txt: Added specs for the
superclass syntax for Struct usage.
2010-05-04 Denis Defreyne <denis.defreyne@stoneship.org>
* templates/default/docstring/html/private.erb,
templates/default/docstring/setup.rb,
templates/default/docstring/text/private.erb,
templates/default/fulldoc/html/css/style.css,
templates/default/module/html/header.erb,
templates/default/module/html/item_summary.erb: Show notification for "@api
private" usage in HTML/text templates. Closes gh-123
2010-04-21 Loren Segal <lsegal@soen.ca>
* LEGAL: Update LEGAL
* .yardopts, LEGAL, LICENSE, README.md, yard.gemspec: Add Ruby/RDoc license
information to YARD and update copyright years. Closes gh-122
2010-04-20 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/cli/yard_graph.rb, lib/yard/cli/yardoc.rb,
lib/yard/templates/helpers/module_helper.rb, spec/templates/module_spec.rb:
Replace the :visibilities option with compilation to a query. This allows
the visibility flags to be used with --list.
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Parse yardopts and manual
args at the same time. This means that e.g. --query arguments are merged,
rather than clobbered.
2010-04-19 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/cli/yardoc.rb: Add a --list option for listing all objects
matching the query.
2010-04-20 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/templates/helpers/method_helper.rb: Don't assume that method
parameter names will be strings. In the case of some overloads with default
values, at least, they'll be symbols.
2010-04-19 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/handlers/ruby/constant_handler.rb,
lib/yard/handlers/ruby/legacy/constant_handler.rb: Register MethodObjects
defined for structs. Otherwise, they don't get their file/line number set.
2010-04-01 Loren Segal <lsegal@soen.ca>
* spec/templates/examples/class001.html,
spec/templates/examples/method001.html,
spec/templates/examples/module001.html,
templates/default/docstring/html/abstract.erb,
templates/default/docstring/html/deprecated.erb,
templates/default/docstring/html/note.erb,
templates/default/docstring/html/todo.erb,
templates/default/fulldoc/html/css/style.css: Fix templates to not wrap
htmlify_line inside a <p> tag, since it itself is a <div>
2010-03-27 Loren Segal <lsegal@soen.ca>
* spec/templates/examples/class001.html,
spec/templates/examples/module001.html: Fix specs for summary toggle button
* 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: Add method/attribute
summary collapse/expand
2010-03-24 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/js/app.js: Don't enable keyboard shortcuts
in frames mode.
* templates/default/fulldoc/html/css/style.css: Move shadow over so it does
not force horizontal scrollbars to appear.
* templates/default/fulldoc/html/js/app.js: Ignore shortcut keypresses inside
form input fields
* templates/default/fulldoc/html/setup.rb: Make sure there are no nil
children
2010-03-22 Loren Segal <lsegal@soen.ca>
* ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec: Bump
version 0.5.4
* templates/default/fulldoc/html/setup.rb: Fix hiding of @private classes in
unresolved namespaces to use @items instead of objects directly
* spec/templates/module_spec.rb: Fix failing spec in 1.8.6
* spec/templates/module_spec.rb, templates/default/module/setup.rb: Fix
testability of mixin list
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
templates/default/module/html/box_info.erb,
templates/default/module/setup.rb: Simplify listing of class/modules used by
a module
2010-03-21 Benjamin Bock <bb--github.com@bock.be>
* templates/default/module/html/box_info.erb,
templates/default/module/setup.rb: add sections "Included in" and "Extending"
for Modules
2010-03-21 Loren Segal <lsegal@soen.ca>
* templates/default/layout/html/setup.rb: Add .mkd file extension for
Markdown
* lib/yard/core_ext/file.rb, spec/core_ext/file_spec.rb: Fix handling of
relative paths that go outside the "initial" directory
* lib/yard.rb: YARD::ROOT should be absolute in 1.8
* templates/default/fulldoc/html/css/style.css: Inline only the first
paragraph of inlined docstrings.
* lib/yard/code_objects/module_object.rb: Avoid listing self as mixin in
inheritance tree
* templates/default/fulldoc/html/js/app.js,
templates/default/fulldoc/html/js/full_list.js: Make keyboard shortcuts more
reliable
* templates/default/fulldoc/html/setup.rb: Ignore @private classes defined in
unresolved namespaces in class list. Closes gh-103
* templates/default/fulldoc/html/css/style.css: Fix breadcrumb link text size
* spec/templates/examples/class001.html,
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,
spec/templates/examples/module001.html: Fix spec expectations for
htmlify_line changes
* lib/yard/templates/helpers/html_helper.rb,
templates/default/fulldoc/html/css/style.css: Change how #htmlify_inline does
inlining
* lib/yard/code_objects/class_object.rb: Ensure default "Object" superclass
is "::Object" (same for BasicObject, Exception) Closes gh-72
* lib/yard/docstring.rb, spec/docstring_spec.rb: Remove only original
indentation from indented @tag text
* lib/yard/code_objects/class_object.rb,
lib/yard/code_objects/module_object.rb,
spec/code_objects/class_object_spec.rb,
spec/code_objects/module_object_spec.rb,
.../default/module/html/inherited_methods.erb: Show extended modules in
inherited methods list as class methods Closes gh-88
2010-03-20 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/js/app.js: Don't activate shortcuts if a
modifier key is down
* lib/yard/docstring.rb, lib/yard/tags/default_factory.rb,
lib/yard/tags/library.rb, lib/yard/tags/overload_tag.rb,
spec/docstring_spec.rb, spec/tags/overload_tag_spec.rb: Remove distinction
between regular and "raw" tag text in the tags API. All tag text is now
delivered as a raw buffer with newlines intact. The API for creating factory
methods is now just `def parse_tag_NAME(tag_name, text)`. This change might
break existing plugins/extensions that add custom tags.
* spec/templates/class_spec.rb, spec/templates/examples/class002.html,
templates/default/class/setup.rb,
.../default/module/html/inherited_methods.erb,
templates/default/module/html/method_summary.erb: Respect @private for
constructors Closes gh-81
* lib/yard/parser/ruby/legacy/ruby_lex.rb: Graceful failure when multibyte
chars are tokenized Closes gh-94
* lib/yard/templates/helpers/method_helper.rb,
spec/templates/helpers/method_helper_spec.rb: Hide &block from argument list
for methods that yield. If a @param tag is specified for the block argument,
the argument will show. Closes gh-77
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
templates/default/fulldoc/html/css/style.css,
templates/default/module/html/constant_summary.erb,
templates/default/module/setup.rb: Show full docstrings for constants.
Closes gh-89 Closes gh-90
* lib/yard/docstring.rb, spec/docstring_spec.rb: Finish parsing @tag when
next line is de-dented. Closes gh-78
* spec/docstring_spec.rb: Refactor docstring specs
2010-03-16 Loren Segal <lsegal@soen.ca>
* lib/yard/templates/helpers/html_helper.rb: Escape HTML inside <tt>/++
typewriter blocks
* lib/yard/parser/ruby/legacy/statement_list.rb,
spec/parser/source_parser_spec.rb: Fix parsing of =begin/=end comments with
multiple consecutive newlines in 1.8
2010-03-14 Loren Segal <lsegal@soen.ca>
* lib/yard.rb: Don't treat 1.9.0 as a true "1.9" Closes gh-97
* templates/default/class/setup.rb: Show child namespaces in class
documentation. Closes gh-98
* templates/default/fulldoc/html/js/app.js,
templates/default/fulldoc/html/js/full_list.js: Add "C", "M" and "F" keyboard
shorcuts to bring up class/method/file menus in non-frame mode. Also can
press escape to close menu. Closes gh-69
* lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,
spec/templates/helpers/html_helper_spec.rb,
templates/default/fulldoc/html/frames.erb,
templates/default/fulldoc/html/full_list.erb,
templates/default/layout/html/headers.erb: Add --charset commandline option
for yardoc to generate HTML docs for a specific charset Closes gh-96
* lib/yard/code_objects/base.rb: Fix documentation for
CodeObjects::Base#method_missing
* lib/yard/templates/helpers/html_helper.rb: Fix method summary listing for
methods ending in =
* templates/default/module/html/method_summary.erb: Show method summary
heading when methods are inherited but none are defined in the class
* lib/yard/autoload.rb, lib/yard/handlers/ruby/legacy/process_handler.rb,
lib/yard/handlers/ruby/process_handler.rb,
spec/handlers/examples/process_handler_001.rb.txt,
spec/handlers/process_handler_spec.rb: Add handler for YARD process blocks
* lib/yard/autoload.rb, .../ruby/legacy/class_condition_handler.rb,
spec/handlers/class_condition_handler_spec.rb: Add class condition handler
for Ruby 1.8
* lib/yard/handlers/base.rb, lib/yard/handlers/ruby/alias_handler.rb,
lib/yard/handlers/ruby/attribute_handler.rb,
lib/yard/handlers/ruby/class_condition_handler.rb,
lib/yard/handlers/ruby/class_handler.rb,
lib/yard/handlers/ruby/class_variable_handler.rb,
lib/yard/handlers/ruby/constant_handler.rb,
lib/yard/handlers/ruby/exception_handler.rb,
lib/yard/handlers/ruby/legacy/alias_handler.rb,
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
lib/yard/handlers/ruby/legacy/class_handler.rb,
.../handlers/ruby/legacy/class_variable_handler.rb,
lib/yard/handlers/ruby/legacy/constant_handler.rb,
lib/yard/handlers/ruby/legacy/exception_handler.rb,
lib/yard/handlers/ruby/legacy/method_handler.rb,
lib/yard/handlers/ruby/legacy/mixin_handler.rb,
lib/yard/handlers/ruby/legacy/module_handler.rb,
.../handlers/ruby/legacy/visibility_handler.rb,
lib/yard/handlers/ruby/legacy/yield_handler.rb,
lib/yard/handlers/ruby/method_condition_handler.rb,
lib/yard/handlers/ruby/method_handler.rb,
lib/yard/handlers/ruby/mixin_handler.rb,
lib/yard/handlers/ruby/module_handler.rb,
lib/yard/handlers/ruby/visibility_handler.rb,
lib/yard/handlers/ruby/yield_handler.rb: Add `process` directive to handlers
which defines the `process` method on the class inside an anonymous module to
make it easier to extend an existing handler with mixins.
* lib/yard/parser/ruby/legacy/statement.rb: Add line_range method
2010-01-29 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/base.rb, lib/yard/cli/yard_graph.rb, lib/yard/cli/yardoc.rb,
lib/yard/cli/yri.rb: Gracefully handle invalid CLI options passed to
yardoc/yri/yard-graph Closes gh-74
* lib/yard/parser/ruby/legacy/statement_list.rb,
lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Add
support for =begin/=end comment strings
2010-01-25 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/templates/template.rb: When dealing with many overloaded
templates, include them in reverse order. This is necessary due to the way
Ruby's module inclusion works with inheritance. Including a module puts it
at the base of the inheritance chain. For example, if a class hierarchy
looks like A->B->C, and C includes D, then it looks like A->B->D->C. This
means that the base template, which is last in the full_paths list, should
actually be included first, so that it ends up farthest back in the
inheritance chain.
2010-01-18 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/autoload.rb, lib/yard/templates/erb_cache.rb,
lib/yard/templates/template.rb, spec/templates/template_spec.rb: Cache the
compiled ERB methods to speed up rendering time.
2010-01-22 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/templates/helpers/html_helper.rb: Allow a broader variety of names
for syntax highlighting. This is necessary to support some names for
Pygments.
2010-01-18 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/templates/helpers/html_helper.rb: HTML-escape text that isn't
syntax highlighted due to --no-highlight.
2010-01-24 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/templates/template.rb: When dealing with many overloaded
templates, include them in reverse order. This is necessary due to the way
Ruby's module inclusion works with inheritance. Including a module puts it
at the base of the inheritance chain. For example, if a class hierarchy
looks like A->B->C, and C includes D, then it looks like A->B->D->C. This
means that the base template, which is last in the full_paths list, should
actually be included first, so that it ends up farthest back in the
inheritance chain.
2010-01-21 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/templates/helpers/html_helper.rb: Allow a broader variety of names
for syntax highlighting. This is necessary to support some names for
Pygments.
2010-01-17 Nathan Weizenbaum <nex342@gmail.com>
* lib/yard/templates/helpers/html_helper.rb: HTML-escape text that isn't
syntax highlighted due to --no-highlight.
* lib/yard/autoload.rb, lib/yard/templates/erb_cache.rb,
lib/yard/templates/template.rb, spec/templates/template_spec.rb: Cache the
compiled ERB methods to speed up rendering time.
2010-01-11 Loren Segal <lsegal@soen.ca>
* README.md: Fix links in README
* templates/default/layout/html/setup.rb: Fix encoding issues when reading
extra files
* lib/yard/templates/helpers/html_helper.rb,
spec/templates/helpers/html_helper_spec.rb: Fix typewrite issues
* README.md: Add info to changelog
* docs/WhatsNew.md: Update what's new
* README.md, lib/yard.rb, yard.gemspec: Bump version to 0.5.3
2010-01-07 Loren Segal <lsegal@soen.ca>
* lib/yard/templates/helpers/html_helper.rb: Fix typewriter text after RDoc
markup is generated
* .gitignore, Rakefile: Remove gem package Rake tasks and use simplified gem
build functionality
* lib/yard/templates/helpers/html_helper.rb,
spec/templates/helpers/html_helper_spec.rb: Fix +text+ RDoc markup showing
\004 characters inside code blocks
2010-01-05 Loren Segal <lsegal@soen.ca>
* templates/default/layout/html/setup.rb: Use default markup provider for
extra files. Also add ability to override markup provider for files with no
extension. Add #!MARKUP shebang to first line of file. Closes gh-64
* templates/default/layout/html/setup.rb: Use raw HTML for .html extra files
* lib/yard/core_ext/string.rb: Fix camelcase bug Closes gh-65
2009-12-31 Loren Segal <lsegal@soen.ca>
* lib/rubygems_plugin.rb: Fix yard gem plugin in 1.8.x with multiple versions
of yard installed Closes gh-62
* lib/rubygems_plugin.rb: Fix has_yardoc accessor
* lib/rubygems_plugin.rb: Don't build yard index if yardoc will run
2009-12-29 Loren Segal <lsegal@soen.ca>
* lib/yard/core_ext/hash.rb, spec/core_ext/hash_spec.rb: Fix another Hash.[]
related issue to make sure array can be passed in as a key
* lib/yard/core_ext/hash.rb: Fix improper Hash.[] implementation Closes
gh-61
2009-12-28 Loren Segal <lsegal@soen.ca>
* lib/yard/templates/template.rb: Remove unused private method call
* lib/yard/templates/template.rb, spec/templates/engine_spec.rb,
spec/templates/template_spec.rb: Fix inclusion of overridden template paths
above format directory. Closes gh-60
* templates/default/fulldoc/html/setup.rb: Remove unecessary line
2009-12-25 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/css/full_list.css: Fix css for arrows
* lib/yard/parser/c_parser.rb: Fix showing entire source file as comment for
class/module
* lib/yard/parser/c_parser.rb: Better linking of variable names to
class/modules
* templates/default/layout/html/breadcrumb.erb: Show proxies namespaces in
small in breadcrumb
* templates/default/fulldoc/html/setup.rb: Show objects from proxies
namespaces
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Add --incremental to
generate only new objects parsed in changed files. Using yardoc -c alone will
now use the cached yardoc but will generate all objects
* yard.gemspec: Fix reloading of yard in Rakefile (1.8)
2009-12-24 Loren Segal <lsegal@soen.ca>
* lib/rubygems_plugin.rb: Improve Rubygems plugin behaviour and generate
.yardoc db for yri
* lib/yard/parser/ruby/legacy/statement_list.rb,
lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Unify
comment parsing behaviour between 1.8/1.9
* templates/default/fulldoc/html/js/full_list.js: Make any click to the left
of an arrow expand the tree rather than select the item
* templates/default/fulldoc/html/css/full_list.css,
templates/default/fulldoc/html/css/style.css,
templates/default/fulldoc/html/full_list.erb,
templates/default/fulldoc/html/full_list_class.erb,
templates/default/fulldoc/html/full_list_files.erb,
.../default/fulldoc/html/full_list_methods.erb,
templates/default/fulldoc/html/js/full_list.js,
templates/default/fulldoc/html/setup.rb: Add tree view implementation for
class list
* spec/code_objects/base_spec.rb, spec/templates/helpers/html_helper_spec.rb:
Fix specs (disable a broken one temporarily)
* templates/default/class/setup.rb: Don't show subclasses for Object
* lib/yard/templates/helpers/html_helper.rb: Use relative path for link
title. Also add more appropriate title tag
* lib/yard/templates/helpers/html_helper.rb,
spec/templates/helpers/html_helper_spec.rb: Update #resolve_links to work
with ({Name}) syntax. Add specs
* lib/yard/code_objects/class_object.rb: Fix behaviour of
ClassObject#superclass=
* lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Add
Base#relative_path to return relative namespace path of two objects
* lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Add check
for creating objects with empty name
* lib/yard/parser/source_parser.rb: Force encoding to source file's encoding
(using # coding shebang line) to properly parse source
* benchmarks/parsing.rb, lib/yard/cli/yardoc.rb,
lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb,
spec/spec_helper.rb: Add --exclude REGEXP to yardoc to ignore paths with a
regexp match. yardoc --exclude '_spec\.rb$' will ignore any file ending in
_spec.rb
2009-12-23 Loren Segal <lsegal@soen.ca>
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
templates/default/module/html/constant_summary.erb: Fix anchor for constants
* spec/templates/examples/class001.html,
spec/templates/examples/class001.txt,
templates/default/class/html/subclasses.erb,
templates/default/class/setup.rb,
templates/default/class/text/subclasses.erb: Fix subclasses not showing in
documentation
2009-12-22 Loren Segal <lsegal@soen.ca>
* templates/default/fulldoc/html/full_list.erb: Move links below header
* templates/default/fulldoc/html/js/app.js: Make summary links work within
frames
* templates/default/fulldoc/html/full_list.erb,
templates/default/layout/html/layout.erb: Add frames class name immediately
(improves UI responsiveness)
* templates/default/fulldoc/html/css/full_list.css,
templates/default/fulldoc/html/css/style.css,
templates/default/fulldoc/html/frames.erb,
templates/default/fulldoc/html/full_list.erb,
templates/default/fulldoc/html/js/app.js,
templates/default/fulldoc/html/js/full_list.js,
templates/default/fulldoc/html/setup.rb,
templates/default/layout/html/breadcrumb.erb,
templates/default/layout/html/search.erb: Add classical frameset view to docs
as frames.html
2009-12-20 Loren Segal <lsegal@soen.ca>
* lib/yard/handlers/ruby/legacy/method_handler.rb: Fix bug in 1.8 handler
* lib/yard/core_ext/file.rb, lib/yard/parser/source_parser.rb,
spec/code_objects/base_spec.rb, spec/parser/source_parser_spec.rb: Add
File.read_binary to fix specs
* 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,
lib/yard/templates/helpers/html_helper.rb,
spec/handlers/attribute_handler_spec.rb,
.../handlers/examples/attribute_handler_001.rb.txt,
spec/handlers/examples/method_handler_001.rb.txt,
spec/handlers/method_handler_spec.rb, spec/templates/examples/module001.html,
templates/default/module/html/item_summary.erb: When a reader/writer method
is defined alongside an attribute, mark it as part of attribute
* lib/yard/cli/base.rb, lib/yard/cli/yard_graph.rb, lib/yard/cli/yardoc.rb,
lib/yard/cli/yri.rb, lib/yard/logging.rb: Show backtraces by default outside
of CLI classes
* lib/yard/code_objects/method_object.rb,
lib/yard/templates/helpers/html_helper.rb,
spec/code_objects/method_object_spec.rb,
spec/templates/examples/module001.dot,
spec/templates/examples/module001.html, spec/templates/module_spec.rb,
templates/default/module/dot/info.erb,
.../default/module/html/attribute_details.erb,
templates/default/module/html/item_summary.erb: Add MethodObject#attr_info
and do not show '=' in attribute's method summary signature
2009-12-17 Loren Segal <lsegal@soen.ca>
* lib/yard/parser/source_parser.rb: Read source in binary mode to be encoding
safe
2009-12-16 Loren Segal <lsegal@soen.ca>
* lib/yard/cli/yardoc.rb: Fix behaviour for --build-gems Closes gh-56
* lib/yard/cli/yardoc.rb: Don't build a gem if there is no yardoc path for
gem
* ChangeLog, lib/yard.rb, yard.gemspec: Bump version to 0.5.2
* lib/yard/cli/yri.rb, lib/yard/core_ext/file.rb, lib/yard/registry_store.rb,
lib/yard/serializers/file_system_serializer.rb, spec/core_ext/file_spec.rb:
Ensure '~/.yard' path is created before writing certain config files. - Adds
File.open! to ensure path exists before writing file Closes gh-57
* lib/yard/registry_store.rb: Return true/false in RegistryStore#load!
2009-12-15 Loren Segal <lsegal@soen.ca>
* docs/WhatsNew.md: Forgot to add version number for changes
* 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