tweak documentation, remove general explanation from api-reference, this is already done in the overview

This commit is contained in:
B. Petersen
2022-01-06 00:41:41 +01:00
committed by bjoern
parent 8fd4d00776
commit 1c081935fb
2 changed files with 5 additions and 6 deletions

View File

@@ -3681,7 +3681,8 @@ char* dc_msg_get_filemime (const dc_msg_t* msg);
* @memberof dc_msg_t
* @param msg The webxdc instance.
* @param filename The name inside the archive,
* must be given as a relative path (no leading `/`).
* can be given as a absolute path (`/file.png`)
* or as a relative path (`file.png`, no leading slash)
* @param ret_bytes Pointer to a size_t. The size of the blob will be written here.
* @return The blob must be released using dc_str_unref() after usage.
* NULL if there is no such file in the archive or on errors.

View File

@@ -10,15 +10,12 @@
## Webxdc API
Webxdc apps can do anything that is allowed in webviews -
html, css, images, canvas, javascript and so on.
There are some additional APIs available once `webxdc.js` is included
(the file will be provided by the concrete implementations,
no need to add `webxdc.js` to your ZIP-file):
```html
<script src="webxdc.js></script>
<script src="webxdc.js"></script>
```
### sendUpdate()
@@ -106,7 +103,8 @@ icon = "icon.png"
If no name is set or if there is no manifest, the filename is used as the app name.
- **icon** - The icon to use for the app.
The icon must be a `.png` or `.jpg` file and is read from the ZIP-file root directory.
The icon should be a square at reasonable width/height.
The icon should be a square at reasonable width/height
and the implementations will add round corners etc. as needed.
If no icon is set or if there is no manifest, a default icon will be used.