FAQ Database Discussion Community


Comments in the .net class library

c#,.net,visual-studio-2013,documentation
I am creating .NET class library, for each class I am adding a documentation on the top of the class: /// <summary> /// Contains helper functions for ... /// </summary> public static class MyHelperClass { /// <summary> /// Helper function for ... /// </summary> public static void HelperFunction() {} }...

Copy to Clipboard and edit the Clipboard

windows,excel,documentation
Let's say I've copied from Google Excel Sheet this content: Click Here I would like to edit the Clipboard to be something like: <div class="button">Click Here</div> Is there a way that I can do that on Windows?...

Where is The Documentation of Font Awesome 4.1.0?

css,fonts,documentation,font-awesome
Anyone know where is the documentation of font-awesome version 4.1.0? I really need it now! The new version (4.3.0) has different class names and images for the icons. So I don't know what are the icons like and it's class name in font-awesome version 4.1.0. Can someone tell me where...

How can i generate domain model diagrams, and documentation

import,documentation,enterprise-architect,domain-model,generated
I imported my project files into Enterprise Architect, under the Domain Model section. The program imported the files correctly, but it did not create domain model diagrams, so i can generate documentation about it, but it is empty. If i imported the project files under the Class model section, class...

How to read javascript frameworks documentation?

javascript,node.js,mongodb,documentation
Coming from the .NET world I am having a hard time consuming documentation for javascript frameworks. I will take "Node.js MongoDB Driver API" as an example. There is a Collection object which has the count() method. Here is the link for it: http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#count From there I see that count() takes...

Where did the internal Rust docs go?

documentation,installer,rust
I just updated my nightly Rust toolchain (rustc 1.2.0-nightly (7c4eedc21 2015-05-25) (built 2015-05-25)) and the docs it installs are now vastly reduced – it's missing all rustc_... crates (apart from rustc_unicode). Is there a possibility to get them back? Do I have to build from source?...

Implementing a custom theme on Sphinx

python,documentation,python-sphinx
I am trying to implement my own custom theme for sphinx locally. I keep running into this error: no theme named 'custom_theme' found (missing theme.conf?). I have a theme.conf in my custom_theme/ directory. Which looks like: [theme] inherit = basic stylesheet = styles/site.min.css In my conf.py I have these following...

Add help to python module

python,documentation,spyder
I use Spyder and for example numpy. Then, when I use some function, like np.interp(), object inspector gives me help about this function. How to put documentation into my modules which will be displayed in Spyder's object inspector?

DocBlock documentation for instances of classes

documentation,phpdoc,docblocks
Could you please give me some guidance on how I should document this piece of code with DocBloc documentation? private $entityManager; public function __construct($entityManager) { parent::__construct(); $this->entityManager = $entityManager; } The $entityManager is an instance of the EnitiyManager class....

Get old-style help in Matlab's command window

matlab,documentation
Short version of question In recent versions of Matlab (I have seen it in R2014b and R2015a on Windows), when you type help foo you get a brief description of the function and its signatures. For example, typing help bsxfun produces something like this (only with better format): This MATLAB...

Undocumented intrinsic routines

delphi,documentation,intrinsics
Delphi has this list: Delphi Intrinsic Routines But that list is incomplete. Which undocumented intrinsic functions exist, since when and what is their purpose? ...

What is this error about perllocale in Perldoc?

osx,perl,debugging,documentation,locale
I was discussing here about setting no locales in Perl and was recommended to run this perldoc perllocale in OSX Yosemite 10.10.3 but I get the error: Error while formatting with Pod::Perldoc::ToMan: at /System/Library/Perl/5.18/Pod/Perldoc.pm line 1346. at /usr/bin/perldoc5.18 line 11. Got a 0-length file from /System/Library/Perl/5.18/pods/perllocale.pod via Pod::Perldoc::ToMan!? at /usr/bin/perldoc5.18...

Getting started with Blend for Visual Studio 2012 Documentation .pdf

visual-studio-2012,documentation,blend
Hi there: How can I download "Getting started with Blend for Visual Studio 2012" documentation from Microsoft website in .pdf format? I dont want to use the internet the whole time when I want this documentation... Here is the link of the documntation https://msdn.microsoft.com/en-us/library/jj171012(v=vs.110).aspx

Yard doc and `define_method`

ruby,documentation,yard
Is there a way to comment methods defined with define_method in YardDoc? I tried this: %w(one two three).each do |type| # The #{type} way # @return [String] the #{type} way define_method("#{type}_way") do ... end end But, unfortunately, not working....

Stripe API Documentation

api,documentation,stripe-payments,documentation-generation
Does anyone know what Stripe uses to generate their api documentation? https://stripe.com/docs/api#intro I'm looking for something that supports multiple programming languages....

Understanding how to use methods found in Apple Developer Reference documentation [closed]

ios,documentation
I've asked a number of questions lately that are fairly newbish. Often, someone from the community answers my questions leaving a foot-note, "it's in the Apple Documentation". The truth is, I don't understand how to translate what I read in the documentation into real-world code. I rely entirely on examples....

Unresolved assembly reference: UnityEngine Sandcastle

visual-studio,unity3d,documentation,sandcastle
I want to create documentation from visual studio xml comments using Sandcastle Help File Builder. My project developed with .Net 3.5 and its class library for Unity3d. When i try to build documentation in Sandcastle all the time Sandcastle return this error : MRefBuilder : error : Unresolved assembly reference:...

How to generate an R package manual

r,documentation
I am wondering how package manuals like this are generated: http://cran.r-project.org/web/packages/knitr/knitr.pdf I have tried to follow steps in this page: http://ase-research.org/R/ which mentions a function manual(pkg), but does not seem to exist....

Where can I find official and up-to-date documentation for the WebRTC API?

google-chrome,firefox,documentation,webrtc
I know about adapter.js, which tries to: insulate apps from spec changes and prefix differences. But adpater.js only covers the very basic WebRTC API's. I'll just use setRemoteDescription as an example. In 2013 it was called like this: pc.setRemoteDescription(offer); According to https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection, the current API is? pc.setRemoteDescription(new RTCSessionDescription(offer), function() {...

What role does hashCode play when comparing two objects?

java,object,documentation,collisions
I've decided to study some primary documentation in Java. I've started with Object class and I am looking at the equals method. I know that equals is using hashCode method. Although, hashCode returns int so there are a limited number of unique hashcodes that can be generated. What will happen...

What are the accepted MIME content types for Google Cloud Storage (GCS)?

json,documentation,mime-types,google-cloud-storage,content-type
I have read the online documentation that I could find relating to uploading files to Google's Cloud Storage service (specifically the JSON api): https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload And on that page it references another page/doc to "See the API reference for each method's list of accepted MIME types and size limits for uploaded...

Summary or toc for autoflask sphinx

python,documentation,python-sphinx,tableofcontents
We use sphinx to document our flask api. It does a pretty good job, but we are having a problem navigating the documentation it generates. We document each blueprint separately. Our blueprints are pretty big. Each is about 1000 lines long, and our docstrings are extremely detailed. The result is...

R functions' aliases documentation

r,documentation
I'm working on R package. I set aliases for some functions this way: foo <- function(){ do_something } foo_alias <- foo I have the documentation for 'foo' function, so when typing: ?foo I get the created documentation. Unfortunately it does not work for foo_alias. When I type: ?foo_alias I get...

Doxygen does not generate links to methods without explicit classname

c#,documentation,doxygen,static-methods,call-graph
I am using Doxygen 1.8.9.1 to generate some html docs for my C# code. The problem is Doxygen does not seem to understand method calls to methods in the same Class unless you explicitly type the class name before the method name. In this example class I have 2 identical...

Online or download the Ruby and Rails API documentation

ruby-on-rails,ruby,api,documentation
Is there a URL that lists the online docs for Ruby as for Rails using the following link? http://api.rubyonrails.org/ Better can I download the API docs for Ruby and Rails for my local machine in the above format? Thanks....

Node.js 0.10 online documentation

node.js,documentation
After Node.js v0.12 release the official documentation now does not allow us to browse node v0.10 docs anymore. Is there online node.js documentation for v0.10 (not the latest one)? Thank you...

Naming a doxygen @ref

syntax,documentation,doxygen,documentation-generation
How would I go about naming a Doxygen @ref tag? I have tried the following: See @ref hello_world hello for more information Which outputs this: See hello_world hello for more information Where hello_world is linked to hello_world. I am looking for this output: See hello for more information Where hello...

I don't undestand documentation about ALAssetPropertyAssetURL

ios,objective-c,documentation,alassetslibrary,alasset
I get asset URL by calling [asset valueForProperty:ALAssetPropertyAssetURL] sometimes it returns nil or may be asset is nil (I've seen it in the crash logs). I've read in the documentation: ALAssetPropertyAssetURL The key to retrieve a URL identifier for the asset. The corresponding value is an NSURL object. This URL...

SOA (web-service) Test Plan templates

web-services,testing,documentation,soa,test-plan
I am looking for a template of Test Plan for web-services testing. I am new in testing of web-services. I have to create a test plan document for one of our web-service. I wanted to know what all heads should be included in the Test Plan or in a better...

Difference between getColumnHeaders(), getColumnNames() and getColumnTitles()

java,scripting,documentation,sap,silktest
I am automating tests using Silk4J. For the SapTree [MicroFocus] class, there are the methods getColumnHeaders() [Microfocus], getColumnNames() [MicroFocus] and getColumnTitles() [MicroFocus]. The description of them is very similar and I'm trying to understand the differences. What I found out so far: the methods return different results. In my case,...

Future cancel method documentation

java,concurrency,documentation,future,java.util.concurrent
According to http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html isDone returns true if cancel(boolean mayInterruptIfRunning) was called. After this method returns, subsequent calls to isDone() will always return true. However, it is possible that task is running and mayInterruptIfRunning is set to false. So, what should return isDone() right after that call? true because of cancel...

Python Language Reference And Function Definitions

python,documentation,bnf,ebnf
As I understand it, the python language reference is written in extended BNF format. While looking at the documentation for function definitions I noticed that the spec doesn't seem to support the usage of trailing *args or **kwargs parameters. parameter_list ::= (defparameter ",")* | "*" [parameter] ("," defparameter)* ["," "...

Documentation for CL's loop macro

loops,documentation,lisp,common-lisp
I'm looking for official documentation for the common lisp loop macro, but all I can find are tutorials and examples. Where can I find this documentation?

Enunciate reporting - How to Exclude few APIs and include few APIs from a same class

java,rest,documentation,javadoc,maven-javadoc-plugin
I would like to exclude few API methods in a class from Enunciate documentation. Is there a way to achieve it using enunciate ? Thanks in Advance...

Using the richness of syntax highlighting produced by asciidoctor

css,documentation,literate-programming,asciidoctor
Asciidoctor will process the file simple.adoc containing: :source-highlighter: pygments [source,java] Foo bar = baz + qux; using pygments to produce many syntax categories We can confirm that the HTML produced is indeed quite rich: <div class="content"> <pre class="pygments highlight"> <code data-lang="java"><span class="tok-n">Foo</span> <span class="tok-n">bar</span> <span class="tok-o">=</span> <span class="tok-n">baz</span> <span class="tok-o">+</span>...

compute string length in Spark SQL DSL

documentation,apache-spark,string-length,apache-spark-sql
I've been trying to compute on the fly the length of a string column in a SchemaRDD for orderBy purposes. I am learning Spark SQL so my question is strictly about using the DSL or the SQL interface that Spark SQL exposes, or to know their limitations. My first attempt...

How to generate the valadoc for a C library (or any library whose bindings ships with vala)?

documentation,vala,gobject-introspection
I want to re-generate the valadoc for the gnome gio-2.0 library (that is part of glib). I'm aware that the complete documentation is available online. I want to be able to generate it locally (ideally without having to rebuild the library myself). Valadoc is able to generate the documentation from...

Latest (master/snapshot) Spark documentation - either online or run locally

documentation,apache-spark
Is there a location where the latest spark documentation has been built and is available? For example the 1.3.0 release candidate branch was cut five days ago but it is not available from the apache site - the newest is the already-in-production 1.2.0. Even better would be the output of...

How to document a regular expression in itself?

c#,regex,documentation
I have a regular expression e.g. at regex101 (\/+[^\/\[\]]+(?:\[[^\]']*(?:'[^']*')\])?)+ I have verified that it matches my test string //SapButton[@automationId='tbar[0]/btn[15]'] Since the Regex cannot be understood rightaway, I tried the documentation feature using (?#), so I changed the Regex to also at regex101 ((?# Capturing group for the type name) \/+(?#...

How to show absolute URLs in API endpoint docs with RAML?

rest,documentation,raml
I'm using RAML to document my REST API. In the RAML doc, I specify the base URL at the root-level baseUri: http://api.example.org/api/{version} version: v1 Then in the API endpoints section of the doc, I specify their URL relative to this base, e.g. /foo/bar: get: description: blah blah blah When I...

Does Apple provide a C documentation of their Operating Systems and where is it?

ios,c,osx,documentation
I need help finding the Apple documentation (I am referring to Apple's additions to the Unix/Posix interface) (if it even exists) but it appears that there is no documentation. (or am I asking a completely wrong question)

Commenting Cassandra's keyspace, table, column

cassandra,documentation
In Oracle there is possibility to add a comment about a table, view, materialized view, or column into the data dictionary, e.g. COMMENT ON COLUMN employees.job_id IS 'abbreviated job title'; I found this particularly usefull as a tester when trying to understand ideas behind the names which are not necessarily...

What is the use of PyCharm's docstring template? How do I use it effectively?

python,coding-style,documentation,pycharm,docstring
PyCharm, the Python IDE generate a template for docstring as I start to type in the docstring. This is the template generated for a simple function. def add_them(x, y): """ :param x: :param y: :return: """ z = x + y return z I dont find it anything similar to...

Passing arguments to a perl package while using it

perl,documentation,arguments,standards,packages
it is possible to pass some arguments while using a package, for example: use Test::More tests => 21; I wasn't able to find any valuable documentation about this featue. Are there any pros and cons of passing such arguments? Best, R....

How to get API documentation to be shown inside Eclipse Help window?

java,eclipse,reference,documentation,javadoc
I've downloaded jdk-8u45-docs-all.zip from here, wrote it's link to my jdk's javadoc location in Eclipse. Everything works just well, when I hover over something the tooltip appears, when I press shift+F2 offline API documentation opens in browser. The only thing that doesn't work - When I write some search query...

How to avoid the “too deeply nested” error when creating PDFs with Sphinx?

python,documentation,pdf-generation,latex,python-sphinx
I have a fairly complex project with a fairly large documentation. Converting the normal user guide to PDF with Sphinx via make latexpdf works quite well. However, if I also want to include the library reference with all function, class, and module documentations, the command fails with: ! LaTeX Error:...

Visual Studio multiple projects C# and C++ documentation

c#,c++,visual-studio,documentation,doxygen
I have a Visual Studio 2013 Solution with multiple projects (C++, C#). So I have different comment styles in the C# files I'm using the XML style. /// <summary> /// Comment /// </summary> In the C++ files I'm using these comments. /*Comment*/ Now I tried to create a documentation with...

adding local references in markdown

documentation,markdown
how to add local references in markdown language? for example i need the following code in rst to be converted in to the markdown. Admin Operations ---------------- .. note:: You need to create an admin session in order to perform admin operations. - :java:ref:`Create Account <com.xxx.yyy.client.Admin.createAccount(String, String, String, String, String)>`...

How to expand error codes in documentation in Apigility?

php,documentation,apigility
I didn't found the way how to describe all my response codes, and I see only default ones. I have a lot of responses, and want to describe them. Also I'm interested in describing different requests which cause 400 response error(for example that request with such kind of data will...

Change Visual Studio 2013 Summary Tag Color on Dark Theme

xml,visual-studio-2013,tags,documentation,themes
When I have the Blue Theme on VS2013, the summary shows as: But when I change to my preferred theme, the Dark theme, the summary tag becomes all green: I like the grayed out version, since it gives more attention to the summary's text, instead of the tag itself, I...

Official documentation for seeding in Ruby on Rails

ruby-on-rails,documentation,seeding
Is there any official documentation on seeding in Ruby on Rails? I've come across third-party documentation in the form of a Railscast episode on it, but I'd also like to know what documentation if any the Rails team has produced. In the Rails guides post on ActiveRecord Migrations, there's a...

Is possible to save Realm documentation for offline reading?

android,ios,documentation,realm
I'm going to vacations this Saturday and I need to have Realm API documentation available for offline reading (https://realm.io/docs/swift/latest/api/index.html). Does it exist somewhere for download? Thanks

What does File.exists? do in Ruby?

ruby,documentation,standard-library
So I was looking through the Ruby standard library docs on how to read a file when I found File.exists?, with this fascinating and illuminating description: exists?(p1)   (A Google search turns up a similar amount of information) It's a real method, as verified by attempting to call it and...

Documentation with Diagram “Hyperlinks” in Enterprise Architect?

documentation,report,documentation-generation,enterprise-architect
I'm struggling to get all the required (and only the required) information into the documentation of my Enterprise Architect Project. Precisely: we have modelled various requirements and displayed the source "standards" for these requirements in our diagrams by using the "hyperlink"-element out of the common toolbox. (This allows us to...

why do angular docs advice not to use public and private scope variables

javascript,angularjs,api,documentation
I'm currently using $$ & $ variables from location service, I just stumbled upon this piece of documentation. It says not to use them but does not provide reason. Please enlighten me! https://code.angularjs.org/1.3.15/docs/api Angular Prefixes $ and $$: To prevent accidental name collisions with your code, Angular prefixes names of...

Documenting code in phpDoc for Laravel 4

php,laravel-4,documentation,phpdoc
I would like to document only the code that I have written in phpDoc. I am using Laravel 4 as my underlying MVC framework. What would be the a good way to structure the code so that I am able to document my code along with all the calling routines...

How to include code excerpts using tags in asciidoc?

documentation,literate-programming,asciidoc
I can include the full Greet.java file public class Greet { public static void main(String[] args) { System.out.println("Hello World!"); } } from within the asciidoc file == Hello Java This is how one greets in Java: [source,java] .Greet.java ---- include::Greet.java ---- producing the documentation But suppose that I only want...

Macro commands to control Excel [closed]

excel,excel-vba,documentation
There is plenty of scripts that use Excel, and they usually have statements like $xlCenter=-4108 $xlTop=-4160 $xlOpenXMLWorkbook=[int]51 $xlConditionValues=[Microsoft.Office.Interop.Excel.XLConditionValueTypes] $xlTheme=[Microsoft.Office.Interop.Excel.XLThemeColor] $xlChart=[Microsoft.Office.Interop.Excel.XLChartType] $xlIconSet=[Microsoft.Office.Interop.Excel.XLIconSet] $xlDirection=[Microsoft.Office.Interop.Excel.XLDirection] I am trying to find a reference to all these commands. I tried googling the variables themselves, but it...

Where is documentation for the Python standard interpreter single underscore “_” builtin variable?

python,documentation,read-eval-print-loop,python-interactive
The single underscore _ in the Python standard interpreter (REPL) is a builtin variable that stores the result of the last evaluation, which I have found useful. Where is the documentation for the interpreter that explains this? The link above is not from the documentation for the interpreter, but from...

Why does VarType() ALWAYS return 8204 for Arrays

vbscript,documentation
In the VarType MSDN Microsoft documentation for VBScript's VarType function it says (With bold emphasis): "Remarks The VarType function never returns the value for Array by itself. It is always added to some other value to indicate an array of a particular type. The value for Variant is only returned...

Best way to document “splatted” parameter with YARD?

ruby,parameters,documentation,yard,splat
I have a method that should take 1+ parameters of any class, similar to Array#push: def my_push(*objects) raise ArgumentError, 'Needs 1+ arguments' if objects.empty? objects.each do |obj| puts "An object was pushed: #{obj.inspect}" @my_array.push obj end end What is the best way to document the method parameters using YARD syntax?...

Does java.util.HashSet not Adhere to its Specification?

java,documentation,hashset,specifications
As a relative Java noob, I was baffled to find out the following: Point.java: public class Point { ... public boolean equals(Point other) { return x == other.x && y == other.y; } ... } Edge.java: public class Edge { public final Point a, b; ... public boolean equals(Edge other)...

Warning: is_subclass_of() expects exactly 2 parameters, 3 given

php,parameters,documentation,subclass,user-documentation
The following code makes use of is_subclass_of, From the PHP documentation, there is a third parameter ($allow_string): bool is_subclass_of ( mixed $object , string $class_name [, bool $allow_string = TRUE ] ) But the following (which uses a redundant parameter as the third argument, to make the code more explicit),...

Explanation of Python doc argument syntax

python,syntax,documentation
Is anyone able to help me to understand the syntax of arguments being passed to some methods in the Python doc? Examples of the type of things that are confusing me would be from the iter() function iter(o[, sentinel]) From my understanding this is equivalent to iter(o, sentinel) but as...

BrickPi Python Documentation

python,documentation,raspberry-pi,raspbian
I'm playing around with a BrickPi on the Raspberry Pi. I'm using Python to control a 4 wheel drive robot. The default program that allows you to control it in real time. But I tried to create a program that gives the robot a set route, ie move forwards 3...

What program does apple uses to create modular javascript files

javascript,module,documentation
When I looked at the new MacBook website from Apple I saw a nice smooth scrolling effect on the wireless page. I started digging in the JavaScript and found an uncompressed JavaScript file and I was blown away. (https://www.apple.com/v/macbook/a/scripts/wireless.built.js) There were so many comments, and you could almost follow what...

Why should I store my Wiki in a separate Repository? [closed]

git,documentation,bitbucket,wiki
I have a private git repository hosted on bitbucket.org. There was also a separate wiki repository created automatically: The wiki itself is actually a git repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will...

What exactly happens when a redis command like 'get' is executed?

redis,documentation
I read that the redis client creates a byte string for the get command and passes it to the server which processes the command. How does the server process the command? Which functions in what order are called? Can someone be elaborate please?

How do I document “trigger_error()” for a class method?

php,error-handling,documentation
If I have the following class method: class ClassA { public function MethodA() { trigger_error('An error has occurred.', E_USER_ERROR); } } ... then what is the accepted way of documenting that it might "throw" (issue) an error using trigger_error() explicitly? The closest I found was to use either @throws, or...

Including images in R-package documentation (.Rd) files

r,documentation,package,visualization,rd
I am working to document a visualization function in a package of mine. For this purpose I would like to have an image embedded through the Rd-file 'funcname.Rd' that could explain various parameters utilized in the function, and which would pop up if user goes to read the package manual...

how to learn and train iOS animation skill [closed]

ios,animation,documentation
I had been read through Core Animation Programming Guide and know simple animation some property But how to training system for my skill to make nice animation and make good use experience What resource should i read and exercise next step?...

Is application change required when new couchbase node added to cluster?

javascript,node.js,sdk,documentation,couchbase
I am using Node.js SDK to connect to a couchbase cluster. In Node.js docs they haven't specified how to pass multiple ips(of cluster nodes) while creating the cluster object but java docs shows it can accept array of IPs, is this functionality available in Node.js SDK too? Also if this...

Can someone please explain these Python string formatters

python,string,python-2.7,documentation
I am confused at the difference between the Python string formatters %d and %i. The Python manual page explains them as the same thing, 'signed integer decimal' - confused ! From the Python 'Built in Types' page...

On youtube api v3 how can I get access to content duration, and genres ? by search or get details

search,youtube,documentation
I tried to use this : https://www.googleapis.com/youtube/v3/playlistItems?part=snippet,contentDetails&{playlist_id}&key={key}&maxResults=50 and https://www.googleapis.com/youtube/v3/search?part=snippet&q=YouTube+Data+API&type=video&videoCaption=closedCaption&key={key}&maxResults=50 It says in the documentation it is contentDetails.duration but this doesn't seem to be present in the data I receive....

statsmodels: Method used to generate condifence intervals for quantile regression coefficients?

python,documentation,statsmodels
I am using the statsmodels.formulas.api.quantreg() for quantile regression in Python. I see that when fitting the quantile regression model, there is an option to specify the significance level for confidence intervals of the regression coefficients, and the confidence interval result appears in the summary of the fit. What statistical method...

What are the differences between javascript's Set and a regular plain object?

javascript,documentation,specifications,ecmascript-6
In trying to solve this question, I learned about the existence of javascript's Set object. I then checked MDN's Set documentation, and the question I am asking here immediately popped up. This debate started in the aforementioned question's answers comments. I found that this thread also contributes to the debate....

How can I download all of Apple's Developer Library PDFs?

ios,osx,documentation,apple
I want the PDF versions of all of Apple's documentation for reference reasons. I do not want to manually go through all of their documentation pages to download it. I've found a number of solutions in the neighborhood of what I need, but not quite exactly this. For instance, it...

Comment tag @code doesn't work with properties

ios,objective-c,properties,documentation,comments
I'm documenting my Objective-C code for the Quick help function in Xcode like this: but I have a little problem in documenting the properties: it's possibile use the tag @code ? Because this comment doesn't work: /** the URL base for backend APIs @code codeexample; @endcode */ @property (nonatomic, strong)...

Possible to use newline inside roxygen2 code block?

r,documentation,r-package
I'm wondering if it's possible to insert newlines inside code blocks in roxygen2 when documenting a function? If I have something inside \code{}, roxygen2 collapses all newlines into single spaces by default. I tried inserting \cr inside to enforce a line break, and I get the desired behaviour, but then...

Show me how can I read apple iOS documentation correctly, please

ios,swift,documentation
I was following a tutorial I found on the web, there was line of code like this: var myImage = UIImage(named: "icon") I understand what this line does, but I don't want to memorize it of course, I want to understand how did the author came up with this code,...

Is the order of two siblings implementation dependent?

xml,tree,documentation,xquery
If I have an XML document like this one: <people> <person> <name> Mario </name> <age> 25 </age> </person> <person> <name> Lucas </name> <age> 32 </age> </person> </people> Is always guaranteed that in the document order, Mario occurs before Lucas? so Lucas is always a following sibling of Mario, or it's...

Understanding socket.io's documentation pattern

javascript,sockets,documentation
In socket.io's server documentation, there is a syntax that is repeatedly used that I'm not familiar with. For example: Server#origins(v:String):Server What is the # referring to? Is it the start of the method? What is the :Server at the end referring to? This pattern of Server#...:Server is repeatedly used, so...

Will leveldb method put update a value?

api,documentation,leveldb
Will the method put update a value or is it necessary to first delete it and then put the new one?

Document Restful API created in Node.JS

javascript,node.js,documentation,swagger
I have created Restful APIs in Node.js and now I plan to document them so they can be shared with others. I spent the past couple of days researching in to this and I found Swagger and started exploring what it had to offer. I really like Swagger-UI, It takes...

Unable to Document Header File with Doxygen

documentation,doxygen,documentation-generation
I'm attempting to generate documentation for a header file that just contains some constants and I'm not able to generate it. As suggested in the doxygen manual, I've tried adding the @file keyword to a comment block and still no luck. What am I missing? Here's a snippet: MyFile.h /**...