GithubHelp home page GithubHelp logo

Create better JavaDoc about cuke4duke HOT 7 OPEN

cucumber-attic avatar cucumber-attic commented on July 19, 2024
Create better JavaDoc

from cuke4duke.

Comments (7)

gaffo avatar gaffo commented on July 19, 2024

+1

from cuke4duke.

martinsson avatar martinsson commented on July 19, 2024

Id be quite satisfied if the sources were available in the maven repo. If I'd fork and add this to the pom, would you merge into master? :

org.apache.maven.plugins
maven-source-plugin


bind-sources

jar



from cuke4duke.

aslakhellesoy avatar aslakhellesoy commented on July 19, 2024

Go for it mate!

from cuke4duke.

aslakhellesoy avatar aslakhellesoy commented on July 19, 2024

Does this mean that a mvn deploy will upload the sources in a jar file next to the binary jars?

from cuke4duke.

martinsson avatar martinsson commented on July 19, 2024

exactly, you'll have : cuke4duke-0.2.5-sources.jar. Then when I click on table.mapToColumn() to see what it does my IDE downloads the sources and displays them automatically, making my life dead simple :)

from cuke4duke.

aslakhellesoy avatar aslakhellesoy commented on July 19, 2024

So - when I get round to writing Javadoc for the APIs - would you then get JavaDoc in the IDE too? (assuming you don't want to read source code). -Or would I have to upload a Javadoc jar file too? Ideally I want to spare folks from reading source code to learn the API, but I'm not familiar enough with what's required fior that...

from cuke4duke.

martinsson avatar martinsson commented on July 19, 2024

Yes you get the javadoc with the sources. Or at least it works in eclipse with the m2 plugin.
I downloaded cuke4duke, made the modification to the root pom,
mvn clean install
And sources were installed to my local repo.

I just sent you a pull request.

Cheers and thanks for your great work.
Johan

from cuke4duke.

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.