Closed FallenAngel97 closed 5 years ago
Running yard gems --rebuild
will rebuild all gems, so the output you are seeing includes many other libraries. If you extract only the gtk3 output, you will find that there is only a single warning:
[info]: Building yardoc index for gem: gtk3-3.3.2
[debug]: Parsing ["{lib,app}/**/*.rb", "ext/**/*.{c,cc,cxx,cpp,rb}"] with `ruby` parser
[debug]: Parsing lib/gtk3.rb
[debug]: Parsing lib/gtk3/box.rb
[debug]: Parsing lib/gtk3/entry.rb
[debug]: Parsing lib/gtk3/image.rb
[warn]: @param tag has unknown parameter name: Hash
in file `lib/gtk3/image.rb' near line 76
[debug]: Parsing lib/gtk3/label.rb
[debug]: Parsing lib/gtk3/paned.rb
[debug]: Parsing lib/gtk3/stack.rb
[debug]: Parsing lib/gtk3/stock.rb
[debug]: Parsing lib/gtk3/table.rb
[debug]: Parsing lib/gtk3/action.rb
[debug]: Parsing lib/gtk3/border.rb
[debug]: Parsing lib/gtk3/button.rb
[debug]: Parsing lib/gtk3/dialog.rb
[debug]: Parsing lib/gtk3/loader.rb
[debug]: Parsing lib/gtk3/widget.rb
[debug]: Parsing lib/gtk3/window.rb
[debug]: Parsing lib/gtk3/builder.rb
[debug]: Parsing lib/gtk3/version.rb
[debug]: Parsing lib/gtk3/calendar.rb
[debug]: Parsing lib/gtk3/show-uri.rb
[debug]: Parsing lib/gtk3/text-tag.rb
[debug]: Parsing lib/gtk3/clipboard.rb
[debug]: Parsing lib/gtk3/combo-box.rb
[debug]: Parsing lib/gtk3/container.rb
[debug]: Parsing lib/gtk3/icon-size.rb
[debug]: Parsing lib/gtk3/icon-view.rb
[debug]: Parsing lib/gtk3/level-bar.rb
[debug]: Parsing lib/gtk3/menu-item.rb
[debug]: Parsing lib/gtk3/text-iter.rb
[debug]: Parsing lib/gtk3/text-view.rb
[debug]: Parsing lib/gtk3/tree-iter.rb
[debug]: Parsing lib/gtk3/tree-path.rb
[debug]: Parsing lib/gtk3/tree-view.rb
[debug]: Parsing lib/gtk3/deprecated.rb
[debug]: Parsing lib/gtk3/gdk-screen.rb
[debug]: Parsing lib/gtk3/icon-theme.rb
[debug]: Parsing lib/gtk3/list-store.rb
[debug]: Parsing lib/gtk3/search-bar.rb
[debug]: Parsing lib/gtk3/stock-item.rb
[debug]: Parsing lib/gtk3/tree-model.rb
[debug]: Parsing lib/gtk3/tree-store.rb
[debug]: Parsing lib/gtk3/ui-manager.rb
[debug]: Parsing lib/gtk3/application.rb
[debug]: Parsing lib/gtk3/binding-set.rb
[debug]: Parsing lib/gtk3/cell-layout.rb
[debug]: Parsing lib/gtk3/spin-button.rb
[debug]: Parsing lib/gtk3/target-list.rb
[debug]: Parsing lib/gtk3/text-buffer.rb
[debug]: Parsing lib/gtk3/tool-button.rb
[debug]: Parsing lib/gtk3/about-dialog.rb
[debug]: Parsing lib/gtk3/action-group.rb
[debug]: Parsing lib/gtk3/css-provider.rb
[debug]: Parsing lib/gtk3/entry-buffer.rb
[debug]: Parsing lib/gtk3/radio-action.rb
[debug]: Parsing lib/gtk3/radio-button.rb
[debug]: Parsing lib/gtk3/scale-button.rb
[debug]: Parsing lib/gtk3/target-entry.rb
[debug]: Parsing lib/gtk3/style-context.rb
[debug]: Parsing lib/gtk3/toggle-action.rb
[debug]: Parsing lib/gtk3/toggle-button.rb
[debug]: Parsing lib/gtk3/combo-box-text.rb
[debug]: Parsing lib/gtk3/message-dialog.rb
[debug]: Parsing lib/gtk3/selection-data.rb
[debug]: Parsing lib/gtk3/text-tag-table.rb
[debug]: Parsing lib/gtk3/tree-selection.rb
[debug]: Parsing lib/gtk3/check-menu-item.rb
[debug]: Parsing lib/gtk3/image-menu-item.rb
[debug]: Parsing lib/gtk3/scrolled-window.rb
[debug]: Parsing lib/gtk3/gdk-drag-context.rb
[debug]: Parsing lib/gtk3/style-properties.rb
[debug]: Parsing lib/gtk3/tree-view-column.rb
[debug]: Parsing lib/gtk3/tree-model-filter.rb
[debug]: Parsing lib/gtk3/file-chooser-dialog.rb
[debug]: Parsing lib/gtk3/font-chooser-dialog.rb
[debug]: Parsing lib/gtk3/gesture-multi-press.rb
[debug]: Parsing lib/gtk3/color-chooser-dialog.rb
[debug]: Parsing lib/gtk3/recent-chooser-dialog.rb
[debug]: Parsing ext/gtk3/rb-gtk3.c
[debug]: Parsing ext/gtk3/extconf.rb
[debug]: Parsing ext/gtk3/rb-gtk3-widget.c
[debug]: Parsing ext/gtk3/rb-gtk3-window.c
[debug]: Parsing ext/gtk3/rb-gtk3-container.c
[debug]: Parsing ext/gtk3/rb-gtk3-tree-view.c
[debug]: Parsing ext/gtk3/rb-gtk3-tree-model.c
[debug]: Parsing ext/gtk3/rb-gtk3-cell-layout.c
[debug]: Parsing ext/gtk3/rb-gtk3-spin-button.c
[debug]: Serializing to /home/angel/.gem/doc/gtk3-3.3.2/.yardoc/objects/root.dat
That's not a big deal, but is something you may want to report to the gtk3 maintainers, since it's not a problem with YARD itself.
It looks like the errors you are seeing are actually coming from glib2 v3.3.2, but it's worth noting that those errors don't stop YARD from producing output, just parsing for specific files (and specifically only seems to affect Glib::MetaInterface). You can actually see that YARD generates docs for GLib at https://www.rubydoc.info/gems/glib2. In any case, as for the specific errors, it's unclear if those are YARD issues or documentation problems, so you may want to open an issue with glib2 for those if you want them resolved, but IMO this isn't going to significantly affect the documentability of that library (since these failing files are pretty much undocumented as is right now).
@lsegal , Thanks, I have reported there
Thanks, I will mark this as closed since YARD seems to be working as intended.
I'm trying to setup solargraph autocomplete for gtk3 gem. My system is Arch linux ruby 2.6.1p33 (2019-01-30 revision 66950) [x86_64-linux]. This fails with a lot of errors/warnings
Steps to reproduce
Actual Output
Expected Output
The documentation for gtk3 gem builds successfully
Environment details:
ruby -v
): ruby 2.6.1p33 (2019-01-30 revision 66950) [x86_64-linux]yard -v
): yard 0.9.18I have read the Contributing Guide.