Code Monkey home page Code Monkey logo

Comments (6)

EmmanuelP avatar EmmanuelP commented on June 9, 2024

Hi.

Do you have a precise example ?

arv_device_get_feature() seems correctly documented: https://aravisproject.github.io/aravis/aravis-stable/method.Device.get_feature.html

from aravis.

dkogan avatar dkogan commented on June 9, 2024

Hi. I guess there're multiple kinds of similar-but-not identical documentation. I was looking at this:

https://aravisproject.github.io/docs/aravis-0.8/ArvDevice.html#arv-device-get-feature

It's missing the info about ownership. Those docs were linked from the main page. Should this be consolidated?

Thanks

from aravis.

EmmanuelP avatar EmmanuelP commented on June 9, 2024

I have removed the link to this obsolete documentation from the main page. I don't even know how it comes there is a content at this location.

from aravis.

EmmanuelP avatar EmmanuelP commented on June 9, 2024

By the way, the old documentation has the information (transfer none). This was made clearer with gi-docgen.

from aravis.

dkogan avatar dkogan commented on June 9, 2024

Awesome; thanks. I just stumbled on two more documentation quirks. Fixing these should be easy, and would make it easier for new users:

  • The top-level page on the documentation server: https://aravisproject.github.io/ doesn't have any useful information or any links to anything that isn't itself. Ideally it should redirect to the docs, or the docs should live there directly
  • I'm looking at the docs for arv_device_write_memory(): https://aravisproject.github.io/aravis/aravis-stable/method.Device.write_memory.html. It says about the "buffer" argument: "The instance takes ownership of the data, and is responsible for freeing it". This isn't right, I'm guessing? If it was, then you wouldn't be able to pass in data on the stack, for instance.
    Thanks

from aravis.

dkogan avatar dkogan commented on June 9, 2024

Oh, and if that snippet is indeed wrong, can the buffer be made const?

from aravis.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.