Documenting CakePHP components [closed] - cakephp

Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I'm mostly concerned with documenting Controller actions, e.g http://foo.bar/app/thing/action/param. How would you recommend documenting these? I'm less interested in the method of generating the documentation (e.g. phpdoc or doxygen) and more a style of doing it. Should I list the parameters and return values as if I were documenting any other method?

In terms of format, I typically follow the same (well, similar) convention used by the CakePHP project itself (http://book.cakephp.org/view/509/Coding-Standards#Commenting-code-601). It's similar enough to JavaDoc that I found it easy to adopt and works nicely with the phpDoc engine. I do tend to include #param values as well as #return. I often find it helpful to provide a bit of additional explanation for acceptable/expected values.

Related

Is it better practice for a React Dapp to a call a Smart Contract using Drizzle or Web3? [closed]

Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed last year.
Improve this question
For my React Dapp to call my smart contracts running on the ethereum block chain, is it better practice to use the Drizzle framework or call Web3 directly?
I recommend using drizzle because it will abstract some complexity and make your code more readable. Also check out drizzle-react it provides some components and decorators that will be super useful.
However, be careful with this type of questions in SO, it might get downvoted, since it's kind of a subjective question and people might have different opinions about it. This community is more about solving coding problems.
Best of luck.

How to use AngularJS for writing the interface of a node-red custom node? [closed]

Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 4 years ago.
Improve this question
I am referring to the .html file associated with the node, not to the UI related nodes. I asked on the official forum and the response was that at the moment Angular is not used. My opinion is that it can be useful for writing nodes faster, without having to use only jQuery.
Thank you!
Short answer, at the this time you can not do this. Asking on here isn't going to get you a different answer.
If you want this to change then you need to make a very strong case (on the forum) as to why this needs to be done. The node's config (as described in the nodes HTML file) really shouldn't be that complicated that it needs a complex framework to lay it out.

Can a pdf splitter on appengine be built? [closed]

Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 9 years ago.
Improve this question
Would it be technically possible to build a pdf splitter on appengine or is there some part of it that couldn't be done? I was thinking of a function where you just upload the pdf file, choose which pages you want and the output is e.g. one chapter from a book and this can be done online. I think it can be a good service but I don't know whether it is technically feasible or whether the best choice first this would be Java, Python, PHP or Go?
I cannot see why not. Splitting a PDF should be possible in all 4 languages so it's up to you what you pick. I know that Python performs faster than Java. PHP doesn't sound like a good fit for me and Go isn't that widely used.
I'd go with Python. There is also a Python library that allows you to split a PDF.

Object detection methodologies [closed]

Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 2 years ago.
Improve this question
I have an assignment of object detection.
I have googled but I didn't find all object detection methods.
Can anyone show me all the methods of object detection?
For starters, have a look at this post.
Then Google around (I'm sorry, you've said you've tried, but I just don't believe that a Google search on object detection gave you zero useful results). Look up things you're not sure about on Wikipedia. Finally, refine your question to be directed at a specific issue. You'll get a lot more useful input that way, and you'll learn more, too.
I don't think anyone here would indulge in teaching you all methods of object detection. To put it bluntly, you're simply asking for too much.

Groovy download files [closed]

Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 4 years ago.
Improve this question
I just had a quick question about downloading files. I was reading this page:
http://groovy.codehaus.org/Simple+file+download+from+URL
Can someone explain what the difference is between the two ways explained on that page? (Aside from overriding the leftshift operator) Is there any significance for doing it one way or the other?
The former method is far cleaner and is what you would do in most cases.
The second is effectively enhancing the File object within the use closure. I can't see where it would be useful in this context, but say in your code you were often putting content from urls into files, or you had a dsl where you wanted to allow for that functionality, you could use categories to extend the file object.
Personally, I see the example as really just showing (a rather impractical) use for categories.

Resources