documentation

How to see docstrings and other symbol information in Common Lisp REPL?

て烟熏妆下的殇ゞ 提交于 2019-11-30 06:31:17
I'm completely new to CL, and I'd like to learn how to read documentation strings and get other help information from the REPL. Something like help(symbol) in Python, or symbol? in iPython, or :t and :i in Haskell's GHCi. So, given a symbol name, I'd like to be able to know: what kind of value it is bound to, if any (a function, a variable, none at all) if it is a function or a macro, then what are its positional arguments if it has a docstring, show it what package or file it is coming from or when it was defined I found there is (documentation '_symbol_ '_type_) , but it is not exactly what

R documentation with Roxygen? [closed]

旧街凉风 提交于 2019-11-30 06:27:00
I find R documentation to be important but also time-consuming to create/maintain. Has anyone used Roxygen yet, and if so, does it help in maintaining an R package? I've used Doxygen in the past, but those projects didn't have the man structure that R packages require. You can find the vignette here . Yes, I use it all the time (in five packages and counting). It's fantastic! With it I managed to create a complete R package (stringr) in about five hours. I recently submitted a patch to get a 10-fold speed up, which makes it even nicer to use. I'd like to start using it, but as far as I know it

Are there javadoc-like tools to generate RESTful web service apidoc from JAX-RS annotations? [closed]

不打扰是莪最后的温柔 提交于 2019-11-30 06:25:02
I'm developing a web service with CXF by using JAX-RS annotations on resources. These annotations specify arguments names, default values, and the valid input and output mime types. It'd be nice to be able to run a javadoc-esque tool on my code to generate a concise set of documentation of this interface, but I cannot seem to find anything. The docs produced by javadoc itself would require too much trimming down, I really want something that understands the semantics of the JAX-RS annotations and generates something friendly to the devs who want to use my service. limc If you are building

How best to write documentation targeting both HTML and PDF? [closed]

帅比萌擦擦* 提交于 2019-11-30 06:23:20
问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed 5 years ago . Latex-to-html converters I've seen in the past have been pretty awful. Editing raw html is no fun and doesn't seem to translate well to the printed page. How do others solve this problem? Links to examples (both pdf and html) would be great. Added: Another similar question was just asked: What formatting

Where can I find good AREL documentation? [closed]

陌路散爱 提交于 2019-11-30 06:05:28
I'm trying to learn as much as I can about AREL. But I'm not sure what to look at. I found some documentation on rubydoc , but it doesn't seem very good in terms of showing what are the "public API"/accessible things I can do. For example, I could not find any information on the "includes" method. So, how exactly to learn most of what AREL has to offer? (i.e. without delving into the source code) I think that this will be useful : https://github.com/brynary/arel And an interesting asciicast : http://asciicasts.com/episodes/215-advanced-queries-in-rails-3 I got tired of reading tests and code,

What are the core elements to include in Support Documentation? [closed]

↘锁芯ラ 提交于 2019-11-30 05:43:37
I have created an application which needs 'hand-over' to the support group in the next month. The application is fairly small (2 months development), and consists of two client side applications and a database, it's written in c# for the windows platform. I have a broad idea of what to include in a support document, but I haven't needed to make very many support documents so far in my career and I want a solid list of items to include. I guess my goal is to make the lives of everyone in the support group easier and as stress free as possible. So I guess my questions are: What should a support

Is there an API in .net to read XML comment documentation file [closed]

自作多情 提交于 2019-11-30 05:05:19
In this question I see that microsoft ships the XML documentation files for the BCL. I wonder if anyone knows if there an API within .net that can be used to look this up at runtime. I know we can parse the files manually using the XML api. The use case is that we allow custom (read 3rd party) types/assemblies to be used in our system, and when selecting these in the UI, we'd like to extract the documentation as specified by the custom type/assembly creator or if not available provide other defaults. I maintain the Jolt.NET project on CodePlex and have implemented a feature that performs this

Where is the filterscript documentation (and how can I use it)? [closed]

﹥>﹥吖頭↗ 提交于 2019-11-30 04:57:33
When Jelly Bean 4.2 was announced a month ago, Filterscript was also announced. It appears to be a language that is a subscript of Renderscript with a different file extension. And that's about all I know about the language. I have read the two total paragraphs that exist about Filterscript on the entire Internet and created a small .fs file with pragma rs_fp_relaxed , but it does not get picked up by the ADT builders like a normal .rs file is in the same location. My ADT is the latest public version (21.0.0), which seems to be too low for Filterscript. tools.android.com appears to have 21.0.1

Where can the documentation for python-Levenshtein be found online? [closed]

跟風遠走 提交于 2019-11-30 04:54:22
I've found a great python library implementing Levenshtein functions (distance, ratio, etc.) at http://code.google.com/p/pylevenshtein/ but the project seems inactive and the documentation is nowhere to be found. I was wondering if anyone knows better than me and can point me to the documentation. You won't have to generate the docs yourself. There's an online copy of the original Python Levenshtein API: http://www.coli.uni-saarland.de/courses/LT1/2011/slides/Python-Levenshtein.html Here is an example: # install with: pip install python-Levenshtein from Levenshtein import distance edit_dist =

Lua's bytecode specification [closed]

二次信任 提交于 2019-11-30 04:46:01
Can anyone tell me where to find Lua's bytecode specification? I've been searching for 15 minutes, and I can't find anything . Maybe A No-Frills Introduction to Lua 5.1 VM Instructions contains what you're looking for? There is also a table of the Lua 5.0 instruction set (Figure 5) in: Ierusalimschy, R.; Figueiredo, L. H.; Celes, W. (2005), "The implementation of Lua 5.0", J. of Universal Comp. Sci. 11 (7): 1159-1176 You can find the full text with a search on Google Scholar and I believe it's on lua.org as well. This reference is used by the Lua page on Wikipedia, which is always a good place