Git Product home page Git Product logo

processing-doclet's Introduction

Since the release of Processing 3.5.4 in January 2020, development has moved to a new repository.

Using a 4.0 release (even an alpha or beta version) is recommended if you find an issue. To avoid confusion, this repo will remain open at least until a 4.0 release is the default download at https://processing.org/download. We chose to move to a new repository so that we could clean out old files accumulated over the last 20 years.

Processing

This is the official source code for the Processing Development Environment (PDE), the “core” and the libraries that are included with the download.

I've found a bug! Let us know here (after first checking if someone has already posted a similar problem). If it's a reference, web site, or examples issue, take that up with folks here. There are also separate locations for Android Mode, or the Video and Sound libraries. The processing.js project is not affiliated with us, but you can find their issue tracker here.

Locked Issues Where possible, I've started locking issues once resolved. This helps reduce the amount of noise from folks adding to an issue that's been closed for years. Because this project has existed for a long time and we have thousands of closed issues, lots of them may sound similar to an issue you're having. But if there's a new problem, it'll be missed if it's lost in a comment added to an already closed issue. I don't like to lock issues because it cuts off conversation, but it's better than legitimate problems being missed. Once an issue has been resolved for 30 days, it will automatically lock.

That processing-bugs fella is suspicious. The issues list has been imported from Google Code, so there are many spurious references amongst them since the numbering changed. Basically, any time you see references to changes made by processing-bugs, it may be somewhat suspect. Over time this will clean itself up as bugs are fixed and new issues are added from within GitHub. Help speed this process along by helping us!

Please help. The instructions for building the source are here. Please help us fix problems, and if you're submitting code, following the style guidelines helps save me a lot of time.

And finally... Someday we'll also fix all these bugs, throw together hundreds of unit tests, and get rich off all this stuff that we're giving away for free. But not today.

So in the meantime, I ask for your patience, participation, and patches.

Ben Fry, 20 January 2019

processing-doclet's People

Contributors

anadroid avatar fdoflorenzano avatar reas avatar sableraf avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

processing-doclet's Issues

Doclet script is broken with Processing 4 (update to `jdk.javadoc.doclet.StandardDoclet` needed)

With the release of Processing 4, we upgraded from JDK 11 to JDK 17 and as a result, our script that parses the JavaDoc comments in the Processing source and creates JSON files in the website repo is broken.

The class that we're using, com.sun.tools.doclets.standard.Standard has been deprecated and replaced with jdk.javadoc.doclet.StandardDoclet which has a whole different API.

We are in need of someone who can evaluate the amount of work required to update the script to use the new class and API and/or make the changes if they are manageable. We understand that this might be a substantial amount of work and we will consider setting a bounty for this task if that is the case.

Please note that this issue is blocking updates to the reference (some examples are linked below) and we would greatly appreciate any help in resolving it, on behalf of the whole Processing community.

Raphaël de Courville
Processing Community Lead Fellow

Edit (20.01.2023): rewrote for clarity and added request for help

Feature request: omit deprecated methods/argument signatures from doclet generation

As the title says: the sound library maintains argument signatures for some methods in its codebase only for backwards compatibility, however they should best be omitted from the online reference, since they would only confuse new users. These methods are already marked as @deprecated in the codebase, so it would be great if the doclet generation could check for such annotations and omit them from the json output.

Library reference ordering and inherited method doclet writeout

I'm currently reorganizing the processing-sound library reference/javadoc and ran into two issues/questions that people more knowledgable than me will hopefully be able to help me with...

  1. the relevant code for this one is probably to be found over in the processing-website repo, but I'll ask it here anyway: the default order of the categories (and subcategories) within the reference listing is alphabetic, but ideally I would like a slightly different ordering for the sound library reference. I can see that the core processing reference also uses a custom ordering of categories, but I can't quite see where the order is actually specified in the current codebase? It seems to be somehow controlled by the Shortcuts component, but I can't seem to find where this is actually instantiated. Some ordering code was introduced by @runemadsen with benfry/processing4@a8f9031 but taken out again by benfry/processing4@48b326b, yet the custom ordering on the website is still in place...

  2. @fdoflorenzano probably knows more about this: @webref annotated methods that are inherited from superclasses are currently not rendered/written to json for the subclasses. Is there a way to turn on doclet generation of inherited methods, either on a per-case basis, or simply for the entire run of the processing-sound doclet build? I tried using {@inheritDoc} but it doesn't look like the doclet supports automatic expansion for this...

Many thanks!
Kevin

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.