Parameters that work both via the command line utility and Xcode: –base-class: The name af the base class which the “private class” (e.g. _MyObject.h) will inherit from. This will also add an import in the form of #import “MyManagedObject.h” to the same .h file. Tip: if the class you want to inherit from is located … Read more
This now supported in VS 2012! Previously, XML tags in the comments were only read in by C++/CLI, not plain old C++. VS 2012 now brings at least some of this into regular C++ – it is in the What’s New in Visual Studio 2012 and in the MSDN docs: XML Documentation (Visual C++). I’ve … Read more
I think the best way to document these is with example code, as Miles has been doing in his experimental macro based branch of shapeless.
A Workaround – Using reflection on Program.DLL/EXE together with Program.XML file If you take a look at the sibling .XML file generated by Visual Studio you will see that there is a fairly flat hierarchy of /members/member. All you have to do is get hold on each method from your DLL via MethodInfo object. Once … Read more
In my experience, ER (or UML) diagrams aren’t the most useful artifact – with a large number of tables, diagrams (especially reverse engineered ones) are often a big convoluted mess that nobody learns anything from. For my money, some good human-readable documentation (perhaps supplemented with diagrams of smaller portions of the system) will give you … Read more
@example http://code.google.com/p/jsdoc-toolkit/wiki/TagExample /** * This function does something see example below: * @example * var x = foo(“test”); //it will show “test” message * * @param {string} str: string argument that will be shown in message */ function foo(str) { alert(str); }
Sure, REST APIs should ideally use HATEOAS and be hypertext driven (with heavy use of media types), but also having simple human-friendly documentation for developers to work off of is helpful. Some specific tools that are helpful for generating documentation like this: Swagger An open spec for describing REST APIs [ github ] Tools for … Read more
While CommonsWare’s answer will work just fine because removing the cookie will reset the language back to the default (English), the proper way to change the language of the Android Developer site to English is use the language spinner at the bottom of the page. This will set your preference and should retain it (by … Read more
Explanation about the available parameters: anchor address: http://www.google.com/calendar/event? This is the base of the address before the parameters below. action: action=TEMPLATE A default required parameter. src: Example: src=default%40gmail.com Format: src=text This is not covered by Google help but is an optional parameter in order to add an event to a shared calendar rather than a … Read more
here are searchable archives from iPhone OS 2.2.1 to iOS 9.2 https://github.com/nst/iOS-Runtime-Headers