processing / processing/processing-website

Reference: Ability to overwrite @return

Đang mở
#398 2 bình luận 0 reaction 1 người được giao Xem trên GitHub

@scotthmurray đang làm issue này rồi.

Từ ngày 19/10/2015.

Enhancement
Ngôn ngữ chính
MDX
Star
90
Fork
122
Merge trung bình
1 giờ 43 phút
Pull request đã merge (30 ngày)
3

Mô tả

Hacking on the reference for processing-io I ran into two things that I couldn't get to work - and I think which might be limitations of the script that cranks out the reference. Posting them as separate issues for reference. Please feel free to close if this is known or very much the expected behavior. (And please tell me if there is a way to do it altogether!)

In Javadoc I sometimes use @return to describe the meaning of the return value. (E.g. that GPIO.digitalRead() returns either GPIO.HIGH or GPIO.LOW.) However the generated reference always just specifies the return type, which is perhaps not in all cases intuitive. I tried overwriting where it mattered in the XML files (setting <returns></returns>, which I found in the video library's files), but this didn't have an influence on the output either.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.