I wrote my html5 game api with haxe and now I want to auto-generate the documentation from the comments in the code. However, I have no idea how to even get started on this. I want to try to use haxedoc but the only documentation I have is on this website and it's not very helpful at all: http://haxe.org/doc/haxedoc
When I run this command: haxe -xml output.xml build.hxml
it says build.hxml does not exist.
How do I get haxedoc to go through my project and generate the documentation?
Specific steps are much appreciated.
You can create a .hxml to use for the documentation. How to create a .hxml is documented here http://haxe.org/doc/compiler#example
Related
I am new to DBT and followed the course to create models, I run dbt docs generate and it passed. But I didn't see the view docs button show up, it was still dark with a question mark. Does anybody know why that happened? I knew it should be very easy but I am so confused why docs wasn't generated with passed codes. Any insights are much appreciated!
Almost there! Now you have to run dbt docs serve
It sounds like you're using dbt Cloud, not the command line, is that right?
Try deleting your target/ folder and re-running dbt docs generate. If that doesn't work, you can reach out to the support team directly in-app.
I am trying to learn Kotlin by following the tutorial. I managed to get the plugin installed in Intellij. But I am not able to get the first exercise to run. When I click on the little checkbok it tells me
Failed to launch checking. See idea.log for more details.
(I created another blank project and type the same simple exercise in a scratch file and it works.)
link to docs
Try to check the project's is linked to the right JDK. Open File/Project Structure/Project. Then select the correct Project SDK.
To me, this helped. But as others have pointed out, please, share your idea.log, which you can find at Help/Show log in [whatever text editor it's associated with].
I'm looking for the way to create inspection to warn about large non-javadoc comments in code. I didn't found any suitable common inspection to do this. It looks like I should create a custom inspection rule. Does anybody know how to do it?
As far as I know, there are two ways to create your own code inspection in IntelliJ IDEA:
(simple but limited way) Creating custom inspection based on "search templates".
(more complex and more powerfull way) Developing an IDEA-plugin (here are the guidlines) using your own InspectionToolProvider implementation as "application-component". Also you may use sources of my inspections-plugin as the starting point.
See http://confluence.jetbrains.com/display/IDEADEV/Developing+Custom+Language+Plugins+for+IntelliJ+IDEA#DevelopingCustomLanguagePluginsforIntelliJIDEA-CodeInspectionsandIntentions. You can look at Open API and Plugin Development forum for assistance.
Is there tool that will give me a detailed report on number lines each file/class in project has?
I tried CLOC. All that I get is that the project level and that is nice to start with. I want a detailed drill down on each class. Do we have any open source tools that will do this for me?
I recommend using sloccount, you will get the LOC by directories and files as expected. You won't be able to have the LOC by class however.
If this limitation is ok, just use the --details flag in the command line you are using, for example if you run the sloccount command in the root directory of your Xcode project::
sloccount --duplicates --wide --details YOUR-TARGET-NAME
The output is a bit hard to read but you will get all the information you need.
If you want to have a nice report and be able to drill down in the directories/files via a HTML report, I suggest using Jenkins. Just install the 'Jenkins plugin for sloccount' via Jenkins UI.
You can see how to setup it in this blog article (disclaimer: I am the author). You will also be able to see examples of such reports.
I use Xcode Assistant...
Download here...
i was looking for a good open source metrics counter for Objective C for a long time... i didn't find any yet...
you can use ProjectCodeMeter http://projectcodemeter.com, but it's not free... hovever the trial version works for 3 months and when it ran out i installed it on my laptop and got another 3 months :)
I only find Xcode Statistician at http://www.literatureandlatte.com/freestuff/index.html
I've been playing with Sublime Text 2 the last few days and was wondering if anyone out there has had any success getting Cocoa method completions working yet? Is there a plugin (or in-progress project to create one) out there?
Any general comments on using Objective-C in Chocolat or Sublime Text 2 would also be welcome.
There is an in-progress Sublime Text package that connects to clang to get autocomplete data called SublimeClang I've not managed to successfully get it to work totally with Cocoa/UIKit Dev, but here's a screenshot
and my options, that are a start
In MacVim I use a plugin called Cocoa.vim which haves useful python scripts that generates a classes and methods files for autocompletion. I didn't try so much with ST2, but may be is posible to create a sublime-package or sublime-completions file with all this data.
For the moment, I only create a sublime-completions file with some snippets. If I find a way to make this work, I will tell you.
I let my SublimeClang configuration options if helps anybody. I've already some of the autocompletions working:
"options":[
"-Wall",
"-isystem", "/Applications/XCode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS6.0.sdk/usr/include/",
"-isystem", "/Applications/XCode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS6.0.sdk/usr/include/c++/4.2.1/",
"-I/usr/lib/clang/3.1/include/**",
"-I", "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/usr/llvm-gcc-4.2/lib/gcc/i686-apple-darwin11/4.2.1/include/",
"-arch","armv7",
"-isysroot", "/Applications/XCode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS6.0.sdk",
"-D__IPHONE_OS_VERSION_MIN_REQUIRED=50000",
"-ferror-limit=0"
]
Answering my own question here. A quick visit to the Sublime forums didn't turn up any leads nor did Google. It looks as though method completions for Objective-C aren't currently part of the default install nor available via 3rd-party quite yet.
This user http://b.rthr.me/wp/?p=368 claims to have gotten SublimeClang working. I may report back myself once I try it...