Questions tagged [documentation]
THIS TAG IS FOR DOCUMENT GENERATORS ONLY. Include language and/or SDE tag as well. DO NOT USE to ask for links to documentation or tools, or to critique vendor documentation.
documentation
4,680
questions
1
vote
0
answers
17
views
Get go doc to follow a type alias and function variable
I am developing a package that has nested packages to assist in organizing my code. My top level package exposes some "aliases" of common functionality nested inside of the other packages ...
0
votes
0
answers
10
views
JSDoc and Documentation.js weird $0. output
I'm currently writing the documentation for my codebase, but I'm getting weird output when trying to unpack an Object in JSDoc to describe its properties.
/**
* Foundational class for sending ...
- 52
0
votes
0
answers
20
views
How does DRF de-serializes the json?
I am using react as frontend and django as backend.
I have used fetch API to send send POST request to the server. The data is passed through JSON.stringify().
This request will be intercepted by ...
0
votes
1
answer
29
views
Does Guile Scheme have a document generator for docstrings or documenting comments?
The source code of Guile Scheme contains docstrings (e.g., https://git.savannah.gnu.org/cgit/guile.git/tree/module/srfi/srfi-43.scm#n107). In the source code of SLib I can event see comments with some ...
0
votes
0
answers
33
views
How can i customize odoo 17 views, like colors, modify the base icons
I want to customize the odoo 17 base theme, to create a customized environment, is there any documentation about it? cause in the odoo documentation there is no info about it.
I donwloaded anoter ...
0
votes
0
answers
30
views
render math equations in doc strings in online documentation [duplicate]
Can mdbook be used to render equations in Rust doc strings? Like, I get that I can used it in book.toml in an mdbook, but can I use it in a rust crate somehow? Is there some other reasonable way to ...
- 1,530
0
votes
0
answers
41
views
How to order class attributes before methods with autoclass in sphinx-docs?
When generating the class docs using .. autoclass:: I tried with the flag autodoc_member_order = 'groupwise'. However, the methods are coming above class attributes.
Any suggestions on how to order ...
0
votes
0
answers
31
views
Why does Swagger duplicate my documentation in endpoints using {format}?
I am creating documentation with Swagger in a Django project, I don't understand why it duplicates some endpoints by adding {format} at first sight they are the same endpoints:
for example GET /...
- 439
-1
votes
0
answers
17
views
Problem of Node.js documentation multiple lines selection by mouse
When I use my mouse to select multiple lines in the Node.js documentation, the scrollbar will easily move up or down even though the cursor just moves a little, which causes the mouse to select amount ...
0
votes
0
answers
22
views
How to generate the API of a websocket request and response using Postman?
I have a Node.js application that functions as a WebSocket server. I can establish a WebSocket connection between my server and Postman, and Postman can receive the response. Now, I need to document ...
- 231
0
votes
1
answer
44
views
How do I document complex function parameters in my own R package?
I am currently transforming my big R-Project into a package and I am trying to document it properly with enough examples and tests.
Some of my functions use parameters that are of a complex type like ...
- 25
-1
votes
0
answers
17
views
isValidUrl from datadog/browser-core
I'm looking for documentation specifically for isValidUrl from datadog/browser-core. I have searched their docs webpage but nothing - https://docs.datadoghq.com/search/?s=isValidUrl
Tried to find the ...
- 470
-1
votes
0
answers
14
views
Where i can find documentation about GeoDirectory plugin, maybe a howTo?
I'm starting a new project with a plugin that is new for me, that plugin is GeoDirectory, and I cant find something like Developer documentations, a real one documentation where i can learn how to ...
- 6,811
0
votes
0
answers
29
views
How to add 3rd party htmls to sphinx index.rst content?
I am working on documenting a project in C++.
The workflow is set as follows: I write my documentation in .h files. The headers are then loaded into Doxygen and html files are generated. These files ...
- 31
0
votes
0
answers
13
views
GraphQL schema documentation based on SPQR and JSR 303 annotations
I'm using the SPQR Spring Boot for GraphQL. My requirement is that if I have JSR-303/380 annotations in the POJO classes, it should be added as comments in the generated schema. Is there any mechanism ...
- 1