yarddoc issues #5197

firefart · 2015-04-19T22:37:43Z

Some of them are fixed in #5196

[warn]: @param tag has unknown parameter name: mssg
    in file `lib/msf/core/exploit.rb' near line 1234
[warn]: @param tag has unknown parameter name: exceptions
    in file `lib/msf/java/rmi/util.rb' near line 28
[warn]: Unknown tag @options in file `lib/msf/core/payload/uuid.rb` near line 98
[warn]: Unknown tag @options in file `lib/msf/core/payload/uuid.rb` near line 98
[warn]: Unknown tag @options in file `lib/msf/core/payload/uuid.rb` near line 98
[warn]: Unknown tag @options in file `lib/msf/core/payload/uuid.rb` near line 98
[warn]: Unknown tag @options in file `lib/msf/core/payload/uuid.rb` near line 98
[warn]: Unknown tag @options in file `lib/msf/core/payload/uuid.rb` near line 98
[warn]: Unknown tag @options in file `lib/msf/core/payload/uuid.rb` near line 98
[warn]: in YARD::Handlers::Ruby::DSLHandler: Undocumentable method, missing name
[warn]:     in file 'lib/msf/core/handler/reverse_http/stageless.rb':6:

    6: require 'msf/core'

[warn]: @param tag has unknown parameter name: opts
    in file `lib/msf/java/rmi/client/jmx/connection/builder.rb' near line 47
[warn]: @param tag has unknown parameter name: opts
    in file `lib/msf/java/rmi/client/jmx/connection/builder.rb' near line 103
[warn]: In file `lib/msf/core/auxiliary/report.rb':62: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/report.rb':159: Cannot resolve link to Mdm::Host from text:
[warn]: ...{Mdm::Host}...
[warn]: In file `lib/msf/core/db_manager/session.rb':115: Cannot resolve link to db_record from text:
[warn]: ...{db_record Msf::Session#db_record}...
[warn]: In file `lib/msf/core/db_manager/session.rb':2: Cannot resolve link to Msf::DBManager#active from text:
[warn]: ...{Msf::DBManager#active}...
[warn]: In file `lib/msf/core/db_manager/session.rb':2: Cannot resolve link to Msf::DBManager#active from text:
[warn]: ...{Msf::DBManager#active}...
[warn]: In file `lib/msf/core/handler/reverse_http.rb':14: Cannot resolve link to #refname from text:
[warn]: ...{#refname}...
[warn]: In file `lib/msf/core/handler/reverse_http.rb':105: Cannot resolve link to #refname from text:
[warn]: ...{#refname}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':53: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':53: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':64: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':64: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':75: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':75: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':139: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/db_manager/import/nexpose/raw.rb':1: Cannot resolve link to “id”=>“winreg-notes-protocol-handler”, from text.
[warn]: In file `lib/msf/core/db_manager/import/nexpose/raw.rb':1: Cannot resolve link to “id”=>“windows-zotob-c”, from text.
[warn]: In file `lib/msf/core/exploit/remote/browser_exploit_server.rb':240: Cannot resolve link to </p> from text.
[warn]: In file `lib/msf/core/exploit/remote/browser_exploit_server.rb':200: Cannot resolve link to CLSID from text:
[warn]: ...{CLSID}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':3: Cannot resolve link to Msf::DBManager#report_web_form from text:
[warn]: ...{Msf::DBManager#report_web_form}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':3: Cannot resolve link to Msf::DBManager#report_web_page from text:
[warn]: ...{Msf::DBManager#report_web_page}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':3: Cannot resolve link to Msf::DBManager#report_web_vuln from text:
[warn]: ...{Msf::DBManager#report_web_vuln}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':92: Cannot resolve link to Msf::DBManager#report_web_form from text:
[warn]: ...{Msf::DBManager#report_web_form}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':128: Cannot resolve link to Msf::DBManager#report_web_page from text:
[warn]: ...{Msf::DBManager#report_web_page}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':175: Cannot resolve link to Msf::DBManager#report_web_vuln from text:
[warn]: ...{Msf::DBManager#report_web_vuln}...
[warn]: In file `lib/metasploit/framework/database.rb':2: Cannot resolve link to configuration_pathnames from text:
[warn]: ...{configuration_pathnames}...
[warn]: In file `lib/metasploit/framework/database.rb':22: Cannot resolve link to configuration_pathnames from text:
[warn]: ...{configuration_pathnames}...
[warn]: In file `lib/metasploit/framework/spec/constants.rb':47: Cannot resolve link to Each.configured! from text:
[warn]: ...{Each.configured!}...
[warn]: In file `lib/metasploit/framework/spec/constants/each.rb':2: Cannot resolve link to configured! from text:
[warn]: ...{configured!}...
[warn]: In file `lib/metasploit/framework/spec/constants/each.rb':95: Cannot resolve link to configured! from text:
[warn]: ...{configured!}...
[warn]: In file `lib/metasploit/framework/spec/constants/suite.rb':2: Cannot resolve link to LOG_PATHNAME from text:
[warn]: ...{LOG_PATHNAME}...
[warn]: In file `lib/metasploit/framework/spec/constants/suite.rb':10: Cannot resolve link to LOG_PATHNAME from text:
[warn]: ...{LOG_PATHNAME}...
[warn]: In file `lib/msf/core/post.rb':4: Cannot resolve link to Mdm::Session from text:
[warn]: ...{Mdm::Session}...
[warn]: In file `lib/msf/core/post.rb':56: Cannot resolve link to Mdm::Session from text:
[warn]: ...{Mdm::Session}...
[warn]: In file `lib/msf/core/module_set.rb':181: Cannot resolve link to Msf::Module#refname from text:
[warn]: {Msf::Module#refname}...
[warn]: In file `lib/metasploit/framework/thread_factory_provider.rb':3: Cannot resolve link to Rex::ThreadFactory#spawn from text:
[warn]: ...{Rex::ThreadFactory#spawn}...
[warn]: In file `lib/metasploit/framework/community_string_collection.rb':10: Cannot resolve link to credentialCollection from text:
[warn]: ...{credentialCollection}...

Once all issues are fixed, maybe we can integrate yard doc into travis and check for yard errors?

The text was updated successfully, but these errors were encountered:

void-in · 2015-04-20T03:44:59Z

Integration with travis will be great since if you take a look at #5059, lots of errors were removed. At that time yard doc would generate the docs without any warning. However these issues crop up again and again since in the module review a lot of times focus is on the ruby code and not that much on the yard comments.

wchen-r7 · 2015-04-20T06:05:26Z

Travis sounds like a good idea for me.

bcook-r7 · 2015-05-04T18:44:43Z

@tdoan-r7 we're wondering if you would be interested in helping sort out the warnings in the inline documentation here.

tdoan-r7 · 2016-04-18T18:36:57Z

Here's the updated error list:

[warn]: Unknown tag @returns in file `lib/msf/core/post/common.rb` near line 61
[warn]: Unknown tag @probe
[warn]: @param tag has unknown parameter name: indent 
    in file `lib/msf/base/serializer/json.rb' near line 19
[warn]: Invalid tag format for @return in file `lib/msf/core/exploit/browser_autopwn2.rb` near line 414
[warn]: Invalid tag format for @return in file `lib/msf/core/exploit/browser_autopwn2.rb` near line 414
[warn]: @param tag has unknown parameter name: options 
    in file `lib/msf/base/simple/framework/module_paths.rb' near line 63
[warn]: @param tag has unknown parameter name:  
    in file `lib/metasploit/framework/login_scanner/manageengine_desktop_central.rb' near line 34
[warn]: @param tag has unknown parameter name:  
    in file `lib/metasploit/framework/login_scanner/manageengine_desktop_central.rb' near line 46
[warn]: in YARD::Handlers::Ruby::DSLHandler: Undocumentable method, missing name
[warn]:     in file 'lib/rex/proto/adb/client.rb':7:

    7: require 'rex/proto/adb/message'

[warn]: in YARD::Handlers::Ruby::DSLHandler: Undocumentable method, missing name
[warn]:     in file 'lib/rex/parser/fs/bitlocker.rb':6:

    6: require 'openssl/ccm'

[warn]: Unknown tag @parameter in file `lib/rex/proto/steam/message.rb` near line 57
[warn]: Unknown tag @options in file `plugins/request.rb` near line 227
[warn]: Unknown tag @options in file `plugins/request.rb` near line 258
[warn]: In file `lib/msf/core/auxiliary/report.rb':71: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/report.rb':168: Cannot resolve link to Mdm::Host from text:
[warn]: ...{Mdm::Host}...
[warn]: In file `lib/msf/core/db_manager/session.rb':107: Cannot resolve link to db_record from text:
[warn]: ...{db_record Msf::Session#db_record}...
[warn]: In file `lib/msf/core/db_manager/session.rb':2: Cannot resolve link to Msf::DBManager#active from text:
[warn]: ...{Msf::DBManager#active}...
[warn]: In file `lib/msf/core/db_manager/session.rb':2: Cannot resolve link to Msf::DBManager#active from text:
[warn]: ...{Msf::DBManager#active}...
[warn]: In file `lib/msf/core/handler/reverse_http.rb':14: Cannot resolve link to #refname from text:
[warn]: ...{#refname}...
[warn]: In file `lib/msf/core/handler/reverse_http.rb':115: Cannot resolve link to #refname from text:
[warn]: ...{#refname}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':5: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':53: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':53: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':64: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':64: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':75: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':75: Cannot resolve link to Mdm::Workspace from text:
[warn]: ...{Mdm::Workspace}...
[warn]: In file `lib/msf/core/auxiliary/auth_brute.rb':139: Cannot resolve link to Metasploit::Credential::Core from text:
[warn]: ...{Metasploit::Credential::Core}...
[warn]: In file `lib/msf/core/db_manager/import/nexpose/raw.rb':1: Cannot resolve link to “id”=>“winreg-notes-protocol-handler”, from text.
[warn]: In file `lib/msf/core/db_manager/import/nexpose/raw.rb':1: Cannot resolve link to “id”=>“windows-zotob-c”, from text.
[warn]: In file `lib/msf/core/exploit/remote/browser_exploit_server.rb':217: Cannot resolve link to CLSID from text:
[warn]: ...{CLSID}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':3: Cannot resolve link to Msf::DBManager#report_web_form from text:
[warn]: ...{Msf::DBManager#report_web_form}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':3: Cannot resolve link to Msf::DBManager#report_web_page from text:
[warn]: ...{Msf::DBManager#report_web_page}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':3: Cannot resolve link to Msf::DBManager#report_web_vuln from text:
[warn]: ...{Msf::DBManager#report_web_vuln}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':92: Cannot resolve link to Msf::DBManager#report_web_form from text:
[warn]: ...{Msf::DBManager#report_web_form}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':128: Cannot resolve link to Msf::DBManager#report_web_page from text:
[warn]: ...{Msf::DBManager#report_web_page}...
[warn]: In file `lib/msf/core/db_manager/import/metasploit_framework/xml.rb':175: Cannot resolve link to Msf::DBManager#report_web_vuln from text:
[warn]: ...{Msf::DBManager#report_web_vuln}...
[warn]: In file `lib/metasploit/framework/database.rb':2: Cannot resolve link to configuration_pathnames from text:
[warn]: ...{configuration_pathnames}...
[warn]: In file `lib/metasploit/framework/database.rb':22: Cannot resolve link to configuration_pathnames from text:
[warn]: ...{configuration_pathnames}...
[warn]: In file `lib/metasploit/framework/spec/constants.rb':47: Cannot resolve link to Each.configured! from text:
[warn]: ...{Each.configured!}...
[warn]: In file `lib/metasploit/framework/spec/constants/each.rb':2: Cannot resolve link to configured! from text:
[warn]: ...{configured!}...
[warn]: In file `lib/metasploit/framework/spec/constants/each.rb':95: Cannot resolve link to configured! from text:
[warn]: ...{configured!}...
[warn]: In file `lib/metasploit/framework/spec/constants/suite.rb':2: Cannot resolve link to LOG_PATHNAME from text:
[warn]: ...{LOG_PATHNAME}...
[warn]: In file `lib/metasploit/framework/spec/constants/suite.rb':10: Cannot resolve link to LOG_PATHNAME from text:
[warn]: ...{LOG_PATHNAME}...
[warn]: In file `lib/msf/core/post.rb':4: Cannot resolve link to Mdm::Session from text:
[warn]: ...{Mdm::Session}...
[warn]: In file `lib/msf/core/post.rb':57: Cannot resolve link to Mdm::Session from text:
[warn]: ...{Mdm::Session}...
[warn]: In file `lib/msf/core/module_set.rb':180: Cannot resolve link to Msf::Module#refname from text:
[warn]: {Msf::Module#refname}...
[warn]: In file `lib/metasploit/framework/login_scanner/snmp.rb':11: Cannot resolve link to #cred_details from text:
[warn]: ...{#cred_details}...
[warn]: In file `lib/metasploit/framework/login_scanner/snmp.rb':64: Cannot resolve link to #cred_details from text:
[warn]: ...{#cred_details}...
[warn]: In file `lib/metasploit/framework/thread_factory_provider.rb':3: Cannot resolve link to Rex::ThreadFactory#spawn from text:
[warn]: ...{Rex::ThreadFactory#spawn}...
[warn]: In file `lib/metasploit/framework/community_string_collection.rb':10: Cannot resolve link to credentialCollection from text:
[warn]: ...{credentialCollection}...
[warn]: In file `lib/rex/parser/fs/bitlocker.rb':12: Cannot resolve link to metadata_entry_type from text:
[warn]: {metadata_entry_type =&gt; {metadata_value_type =&gt; [fve_entry,…]}...
[warn]: In file `lib/rex/parser/fs/bitlocker.rb':10: Cannot resolve link to PROTECTION_TYPE from text.
[warn]: In file `lib/rex/parser/fs/bitlocker.rb':115: Cannot resolve link to metadata_entry_type from text:
[warn]: {metadata_entry_type =&gt; {metadata_value_type =&gt; [fve_entry,…]}...
[warn]: In file `lib/rex/parser/fs/bitlocker.rb':217: Cannot resolve link to PROTECTION_TYPE from text.

Fix rapid7#5197 Fixed issues that caused errors during yard doc generation

firefart added docs bug labels Apr 19, 2015

bcook-r7 assigned wchen-r7 Apr 27, 2015

bcook-r7 assigned tdoan-r7 and unassigned wchen-r7 May 4, 2015

bcook-r7 closed this as completed May 4, 2015

bcook-r7 reopened this May 4, 2015

firefart mentioned this issue Apr 18, 2016

fix some yardoc issues #6787

Merged

tdoan-r7 added a commit to tdoan-r7/metasploit-framework that referenced this issue Apr 20, 2016

Fix rapid7#5197, Fixed yard doc errors

9ce5c9b

Fix rapid7#5197 Fixed issues that caused errors during yard doc generation

tdoan-r7 mentioned this issue Apr 20, 2016

Fix #5197, Fixed yard doc errors #6794

Closed

2 tasks

waffleio-r7 added the in progress label Apr 20, 2016

wchen-r7 closed this as completed in 5e36a31 Apr 21, 2016

waffleio-r7 removed the in progress label Apr 21, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

yarddoc issues #5197

yarddoc issues #5197

firefart commented Apr 19, 2015

void-in commented Apr 20, 2015

wchen-r7 commented Apr 20, 2015

bcook-r7 commented May 4, 2015

tdoan-r7 commented Apr 18, 2016

yarddoc issues #5197

yarddoc issues #5197

Comments

firefart commented Apr 19, 2015

void-in commented Apr 20, 2015

wchen-r7 commented Apr 20, 2015

bcook-r7 commented May 4, 2015

tdoan-r7 commented Apr 18, 2016