{"id":163,"date":"2008-12-21T21:40:03","date_gmt":"2008-12-21T21:40:03","guid":{"rendered":"https:\/\/blackcompanystudios.co.uk\/blog\/?p=163"},"modified":"2008-12-21T21:40:03","modified_gmt":"2008-12-21T21:40:03","slug":"library-documentation","status":"publish","type":"post","link":"https:\/\/blackcompanystudios.co.uk\/blog\/library-documentation\/","title":{"rendered":"Library documentation"},"content":{"rendered":"<p>Okay, note to library developers. When you&#8217;re providing documentation for your class library, a bunch of pages like:<\/p>\n<blockquote><p>SomeObject::GetID method<\/p>\n<p>Gets the ID for the object<\/p><\/blockquote>\n<p>Does not mean that you have thorough documentation. Seriously. That is all.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Okay, note to library developers. When you&#8217;re providing documentation for your class library, a bunch of pages like: SomeObject::GetID method Gets the ID for the object Does not mean that you have thorough documentation. Seriously. That is all.<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"jetpack_publicize_message":"","jetpack_is_tweetstorm":false,"jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false}}},"categories":[5],"tags":[250,95],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/pg1JR-2D","jetpack_sharing_enabled":true,"jetpack_likes_enabled":true,"_links":{"self":[{"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/posts\/163"}],"collection":[{"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/comments?post=163"}],"version-history":[{"count":1,"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/posts\/163\/revisions"}],"predecessor-version":[{"id":222,"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/posts\/163\/revisions\/222"}],"wp:attachment":[{"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/media?parent=163"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/categories?post=163"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blackcompanystudios.co.uk\/blog\/wp-json\/wp\/v2\/tags?post=163"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}