vala-lang / valadoc-org Goto Github PK

On this page, the box which says "All known members inherited from class string" is not expandable in Epiphany. I'm not sure if it's the code faulty, or it's the fault of webkit2gtk.

Hover over a bunch of things and scroll down

@Bat41 - this is new since your es6 change

Hi, I was working on fixing the tooltips tonight but I can't get the darn app to install because npm fails for me on the install of the gulp dependency which is for some reason is pointing at github so npm tries to do a git checkout and fails because for some reason after it clones the project to /tmp there are changed files (pngs) I was wondering if the version of npm/node mattered. Will probably try a different version of the module but It would be nice to let people know what version is used.

www. is dead, once it is redirected we should push it all into valadoc.org

When building the valadoc website, gtkmozembed triggers an assertion failure:

create 'gtkmozembed' ...
**
ERROR:/var/valadoc/src/generator.vala.c:2234:valadoc_index_generator_generate_wiki_index: assertion failed: (stream != null)
Aborted (core dumped)
Makefile:103: recipe for target 'build-docs' failed

Should check with @flobrosch about the licensing and then make sure we add a license file

The documentation for WebKit.UserContentManager.register_script_message_handler seems to have some kind of corrupted xml tags mingled into the text. I'm not sure where the correct place to report this bug is, but the problem doesn't seem to exist in the upstream WebKit doc comments. Looking at the HTML, it looks more like some kind of line-wrapping or post-processing is to blame.

Would it be possible to make the size of the sidebar changeable? To drag it bigger or smaller?

Parts of the content are always hided and although you have the pop up when hovering over an entry I would prefer to read them directly.

If you're at valadoc.org/ it works fine, but at /index.htm you get an error

Query failed: (1064) sphinxql: syntax error, unexpected INDEX, expecting IDENT (or 49 other tokens) near 'index=2)'

Due to us centering the content area, sometimes when there is little content, the area will be super small.

e.g. if i search for Box, i want to see Gtk.Box at the top, not ClutterGst.Box

This only happens when you follow a link to the page

e.g.

Hi, there is some missing devhelp packages in valadoc.org:

• appstream
• gio-2.0
• glib-2.0
• gxml-0.14
• gvncpluse-1.0
• gvnc-1.0
• gobject-2.0
• libgdaui-5.0
• libgitg-ext-1.0

Migrating this issue from the old repo:

Given that there's already some activity in web frameworks for Vala, like Valum, I think there's some value into using an existing Vala solution, support the underdog, etc.

When you click a sidebar link, all sidebar tooltips stay in the same position and do not hide.

The docs for some methods splits at the first period into two separate <p> elements. See:
https://valadoc.org/gio-2.0/GLib.SocketService.start.html

So when looking at the overview page, it trims a significant portion of the annotation:
https://valadoc.org/gio-2.0/GLib.SocketService.html

I can only speculate that this is a heuristic done by the MarkupReader in valadoc for functions whose docs don't conform to the traditional "single-line summary followed by full description", but I'm not sure at all how to fix this...

I'm not sure if we have a elementary solution for this or if we'll use https://github.com/eustasy/bubbly

there are vala tutorials/examples/samples all over the web, it might be worthwhile to pull these into valadoc and put the responsibility for keeping them accurate/updated/relevant in the hands of the the documentation team.

They're generally buggy, and don't dismiss properly

Can't seem to find any docs for GeoClue2

qrencode package on valadoc: https://valadoc.org/qrencode/index.htm
Currently the description of package qrencode contains a link to 'Home' as http://megaui.net/fukuchi/works/qrencode/index.en.html. This link give a 404 Not Found.
I came across another link https://fukuchi.org/works/qrencode/manual/index.html which is live.

It would be really nice if there were a static link, say "valadoc.org/packages.json" that contains the list of currently available packages in this way:

{
  "books": [
    {
      "name": "glib-2.0",
      "description": "GLib provides the core application building blocks for libraries and applications written in C. It provides the core object system used in GNOME, the main loop implementation, and a large set of utility functions for strings and common data structures.",
      "version": "2.51.2",
      "book_url": "https://valadoc.org/glib-2.0/glib-2.0.tar.bz2"
    },
    {
      "name": "gio-2.0",
      "description": "GIO provides a modern and easy-to-use VFS API. It provides a file system abstraction which allows applications to access local and remote files with a single consistent API.",
      "version": "2.51.2",
      "book_url": "https://valadoc.org/gio-2.0/gio-2.0.tar.bz2"
    }
  ]
}

So that it's possible to list the available packages to users in order to use them offline.

OS : elementary OS 0.4.1 Loki
Kernel : 4.8.0-54-generic

===== libgitg-ext-1.0 =====
valadoc --target-glib 2.99 --driver "0.34" --importdir girs --doclet "." -o "tmp/libgitg-ext-1.0" "girs/vala/vapi/libgitg-ext-1.0.vapi" --vapidir "girs/vala/vapi" --girdir "girs/gir-1.0" --pkg libgitg-1.0 --pkg ggit-1.0 --pkg Soup-2.4 --pkg WebKit2-4.0 --pkg gee-0.8 --pkg gtk+-3.0 --use-svg-images --importdir "girs/gir-1.0" --import GitgExt-1.0 --metadatadir documentation/libgitg-ext-1.0 --wiki documentation/libgitg-ext-1.0/wiki
/home/itsme/dev/valadoc-org/girs/gir-1.0/GitgExt-1.0.gir:13.2-13.43: error: unknown child element `attribute' in `namespace'
	<attribute name="ccode.gir-namespace" value="GitgExt"/>
	^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^               
/home/itsme/dev/valadoc-org/girs/gir-1.0/GitgExt-1.0.gir:14.2-14.55: error: unknown child element `attribute' in `namespace'
	<bitfield name="ExternalChangeHint" c:type="GitgExtExternalChangeHint" glib:type-name="GitgExtExternalChangeHint" glib:get-type="gitg_ext_external_change_hint_get_type">
	^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^                                                                                                                     

(valadoc:29148): GLib-CRITICAL **: g_str_has_suffix: assertion 'str != NULL' failed

** (valadoc:29148): CRITICAL **: valadoc_importer_gir_documentation_importer_attach_comment: assertion 'cname != NULL' failed
Failed: 2 error(s), 0 warning(s)

from LOG file.

Anyone could help me to solve this problem please?

The last edit for the GNOME one was in 2015, and this one was updated 3 months ago. GitBooks is also a lot nicer to read than the GNOME wiki and you can contribute to the tutorial on GitHub

with search capabilities

I noticed a couple of hours ago that search is no longer working.
I'm getting this error:

Error 500: Internal Server Error. When loading /.
Click here to go to the homepage

Icons & text feel too close together on the horizontal axis as well as too close to the left edge of the page, to me. Difference in spacing(or padding) between horizontal and vertical axis is very pronounced.
Looking at Files' sidebar, for reference: difference in spacing is way less pronounced -- barely noticeable. Biggest difference is, in Files, padding from the left edge is bigger.

Images attached, for reference.

Roughly playing around, just for checking, I got the results I was looking for by changing:
Added: "padding: 4%" to #navigation-content
Changed: "padding: 4%" in #sidebar .navi_main a
(pictured in "Valadoc Sidebar - After (Suggested).png")

What do you think?

To better see the difference, click to open the images.

Before (Current)

After (My suggestion)

Files:

This way we always use the latest version and we don't need system-specific options in packages.xml

It doesn't appear that the Sphinx search index is being rebuilt after each new documentation update.

For example both gee-0.8 and libcolumbus have had documentation built in the last few weeks, but neither appear when entering relevant terms in search. Typing "ArrayList" does not return Gee.ArrayList. Also the tooltips for these libraries' documentation return "Query failed: (1064) no enabled local indexes to search". Whereas the tooltips for libraries that appear in search are fine. This suggests the newer documents have not been indexed. Ideally this would be done automatically.

if you run make serve-mini it builds docs for glib-2.0 and gio-2.0, but if you go to a GObject and click on 'object' it 404s. Should we be building docs for gobject-2.0 because it is a dependency of gio-2.0?

Tests are nice. I like tests.

To ensure that pull requests will actually build

This depends on valadoc giving us a style class, but just making a note here so we know it's a thing

The direct link, https://valadoc.org/gxml-0.10/index.htm , shows blank content. Clicking the link on the side menu shows "Error 0: . When loading /gxml-0.10/." So it looks like there was an error when building the gxml-0.10 docs.

Using the VAPI at https://github.com/nemequ/vala-girs/blob/master/vala/vapi/gxml-0.10.vapi I can build the docs fine with the command:
valadoc --directory gxml-0.10 --pkg gee-0.8 --pkg gio-2.0 --pkg libxml-2.0 gxml-0.10.vapi
This suggests there is something wrong in the valadoc-org build somewhere rather than the source.

Use Babel to transpile it, and drop JQuery by the way if possible.

And I think I'll start working on it right now. 🙂

because machines are better than humans at that sort of thing

Something that would be useful (because of the nature of distros), is what package versions an API was last changed by. For example, someone just asked about gtk.stacksidebar and why it's not working in elementary OS. The reason is that it is new to gtk 3.16, and we ship gtk 3.14. If the docs said something like "since gtk 3.16" that would be awesome.

Bounty

It would be good to add docs for Dazzle as it's use becomes more widespread in the GNOME community and possibly for Builder (libide) as well to ease plug-in development

It's still pulling from Launchpad. It should pull from GitHub now

http://stackoverflow.com/questions/tagged/vala

load_images_vapi() downloads images when vapi-image-source= is specified. If there are no images downloaded, wget will not have created the directory documentation/<package>/vapi-images/, and valadoc will break. You can try this with rm -rf valadoc.org && make build-docs. It should fail on granite

https://valadoc.org/appstream/index.htm
There is no documentation under appstream…

Hey guys, so on this page, I can see some information like "Deprecated since 2.44: use Gio.FileMonitorFlags.WATCH_MOVES instead.", which is extremely useful. In valadoc.org, it's only displayed when you click on the enum field, but it's not displayed on the main page.

Dan says there's also supposed to be a strike-through style for deprecated items.

[Error] Failed to load resource: the server responded with a status of 404 (Not Found) (fetch.js, line 0)

[Error] TypeError: document.querySelectorAll('body > div a').forEach is not a function. (In 'document.querySelectorAll('body > div a').forEach(setupLink)', 'document.querySelectorAll('body > div a').forEach' is undefined)
	(anonymous function) (valadoc.js:146)

[Error] ReferenceError: Can't find variable: fetch
	search (valadoc.js:20)
	(anonymous function) (valadoc.js:206)

Errors form Epiphany 3.20.3. Same errors in Pale Moon 27.4.0

1. Using the direct link, http://valadoc.org/gee-0.8/index.htm , results in a blank page and sidebar menu.

2. Following the gee-0.8 link in the sidebar menu gives the error "Error 0: . When loading /gee-0.8/index."

3. Searching for a Gee data structure, for example TreeMap, shows no results