Giter Club home page Giter Club logo

Comments (5)

killercup avatar killercup commented on August 26, 2024

This should be possible, /// hi there comments become #[doc="hi there"] attributes.

Would you want to differentiate between comments for the struct field and comments for the setter? (If the field is not public, its docs wouldn't be rendered, so it might be cool to just add them to the setter fn.)

from rust-derive-builder.

mre avatar mre commented on August 26, 2024

Thanks for the quick response.
Documentation for the setter would be enough for me right now. But a fallback for non-public fields would be totally awesome. Depends on how tricky it is to implement.

from rust-derive-builder.

colin-kiegel avatar colin-kiegel commented on August 26, 2024

@mre thank you very much for your feedback. :-)

A simple solution would be to allow item doc-comments, but to skip over them and use auto-generated documentation for setters. Spontaneously that is what I would try first and then wait and see if there is a big need for something more sophisticated or magic.

from rust-derive-builder.

colin-kiegel avatar colin-kiegel commented on August 26, 2024

Ok, for now we have auto-generated doc-comments (95f3b4b)

/// Set `$field_name`
///
/// auto-generated by [derive_builder](https://crates.io/crates/derive_builder)

Skipping doc-comments (and pub keywords) in the struct definition is a bit more delicate and therefore a pull request #14

I am open for future changes - but I think this is at least an improvement of the current state. I will release now without the pull request. ;-)

from rust-derive-builder.

colin-kiegel avatar colin-kiegel commented on August 26, 2024

implemented and published with v0.2.0 (Changelog)

from rust-derive-builder.

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.