{"id":307,"date":"2015-06-06T13:50:29","date_gmt":"2015-06-06T20:50:29","guid":{"rendered":"http:\/\/www.icetips.com\/blog_wp\/?p=307"},"modified":"2015-06-06T19:31:06","modified_gmt":"2015-06-07T02:31:06","slug":"xml-help-in-icetips-utilities","status":"publish","type":"post","link":"http:\/\/www.icetips.com\/blog_wp\/2015\/06\/06\/xml-help-in-icetips-utilities\/","title":{"rendered":"XML help in Icetips Utilities"},"content":{"rendered":"

One of the very cool things in the new IDE is the support for XML help. This is the information entered into .INC files using triple exclamation mark (!!!) comments. This makes a quick help accessible right in the IDE. \u00a0I have been working on documenting the ITUtilities.inc file and I'm about half way through it. \u00a0It doesn't replace the documentation but once I have gone through and documented the ITUtilities.inc it will be much easier for me to dig through getting the full documentation done.<\/p>\n

Below is an example from the ITImageClass in the Utilities:<\/p>\n

!!!<summary>\r\n!!! Sets the position of the image withing a boundary control.\r\n!!!<\/summary>\r\n!!!<param name='pImageFEQ'>The control with the image<\/param>\r\n!!!<param name='pRelativeFEQ'>The relative boundary control<\/param>\r\n!!!<param name='pX'>Adjust horizontal placement<\/param>\r\n!!!<param name='pY'>Adjust vertical placement<\/param>\r\n!!!<param name='pJust'>Justification of the image inside \r\n!!! the boundary control<\/param>\r\n!!! <para><\/para>\r\n!!! <para>The horzontal justification can be one of:<\/para>\r\n!!! <para> IT_IMAGE_JUST:LEFT<\/para>\r\n!!! <para> IT_IMAGE_JUST:CENTER<\/para>\r\n!!! <para> IT_IMAGE_JUST:RIGHT<\/para>\r\n!!! <para><\/para>\r\n!!! <para>The vertical justification can be one of:<\/para>\r\n!!! <para> IT_IMAGE_JUST:TOP<\/para>\r\n!!! <para> IT_IMAGE_JUST:MIDDLE<\/para>\r\n!!! <para> IT_IMAGE_JUST:BOTTOM<\/para>\r\n<\/pre>\n
In the IDE, when you are entering the name of the method in the editor it will show you a tooltip with all the information above:<\/p>\n
\"2015-06-06_12-32-46\"<\/a><\/p>\n
Click on the image to load a full size screenshot.<\/p>\n
Arnor Baldvinsson<\/em><\/p>\n
<\/div>\n
<\/path><\/svg><\/i> \"Loading\"<\/p>\n
<\/div>\n","protected":false},"excerpt":{"rendered":"
One of the very cool things in the new IDE is the support for XML help. This is the information entered into .INC files using triple exclamation mark (!!!) comments. This makes a quick help accessible right in the IDE. \u00a0I have been working on documenting the ITUtilities.inc file and I'm about half way through ...continue reading XML help in Icetips Utilities<\/span><\/a><\/p>\n
<\/div>\n
<\/path><\/svg><\/i> \"Loading\"<\/p>\n
<\/div>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"categories":[4,6],"tags":[],"class_list":["post-307","post","type-post","status-publish","format-standard","hentry","category-products","category-news"],"_links":{"self":[{"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/posts\/307","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/comments?post=307"}],"version-history":[{"count":6,"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/posts\/307\/revisions"}],"predecessor-version":[{"id":318,"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/posts\/307\/revisions\/318"}],"wp:attachment":[{"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/media?parent=307"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/categories?post=307"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.icetips.com\/blog_wp\/wp-json\/wp\/v2\/tags?post=307"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}