{"id":537,"date":"2012-01-03T09:54:07","date_gmt":"2012-01-03T14:54:07","guid":{"rendered":"https:\/\/blogs.mathworks.com\/desktop\/?p=537"},"modified":"2012-01-03T09:54:07","modified_gmt":"2012-01-03T14:54:07","slug":"using-the-help-report","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/community\/2012\/01\/03\/using-the-help-report\/","title":{"rendered":"Using the Help Report"},"content":{"rendered":"<p>Last week Jiro picked <tt>addcopyright<\/tt> for the <a target=\"_blank\" href=\"https:\/\/blogs.mathworks.com\/pick\/2011\/12\/30\/automatically-add-copyright-information-to-your-matlab-files\/\">File Exchange Pick of the Week<\/a>. The pick looks like a helpful tool for adding copyright text to MATLAB program files, but while reading the post, I was reminded of the <a href=\"https:\/\/www.mathworks.com\/help\/releases\/R2011b\/techdoc\/matlab_env\/f9-6232.html#f9-6117\" target=\"_blank\">Help Report<\/a>, which is part of MATLAB&#8217;s current folder reports. <\/p>\n<p>The Help Report scans the <tt>.m<\/tt> files in the current folder and analyzes the text help at the top of the file. This is the text displayed in the Command Window, when you use the <tt>help<\/tt> command. The report is most useful if you want to create MathWorks-style help for your own code, but is still useful even if you use only a part of it. <\/p>\n<p>One of the features the report has is the ability to flag a missing Copyright or update a Copyright line if it is out of date. It also checks for H1 text, examples, &#8220;see also&#8221;, and even scans class methods for help text.<\/p>\n<p>To run the help report, go to the Actions &#8220;gear&#8221; in the current folder browser, and select Reports -> Help Report. This generates a HTML report of each file in the current folder and what help pieces are present. You can use the checkboxes at top to deselect the parts of help you don&#8217;t care about for your files. <\/p>\n<p><img alt=\"\" title=\"https:\/\/www.mathworks.com\/help\/releases\/R2011b\/techdoc\/matlab_env\/tuning_refining6_10a.png (link no longer works)\" class=\"aligncenter\" width=\"406\" height=\"446\" \/><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Last week Jiro picked addcopyright for the File Exchange Pick of the Week. The pick looks like a helpful tool for adding copyright text to MATLAB program files, but while reading the post, I was&#8230; <a class=\"read-more\" href=\"https:\/\/blogs.mathworks.com\/community\/2012\/01\/03\/using-the-help-report\/\">read more >><\/a><\/p>\n","protected":false},"author":38,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[4],"tags":[35,185,186,184,42],"_links":{"self":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/posts\/537"}],"collection":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/users\/38"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/comments?post=537"}],"version-history":[{"count":4,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/posts\/537\/revisions"}],"predecessor-version":[{"id":542,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/posts\/537\/revisions\/542"}],"wp:attachment":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/media?parent=537"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/categories?post=537"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/tags?post=537"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}