Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc improvements #214

Merged
merged 36 commits into from
Nov 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
59a8e02
cleanup
mcorino Nov 7, 2023
06d2672
doc customization
mcorino Nov 7, 2023
5aae58c
add kramdown gem and use for yardoc markup
mcorino Nov 8, 2023
908d331
remove asset copying step as yardoc does that now
mcorino Nov 8, 2023
0abb136
use proper namespacing
mcorino Nov 8, 2023
5f385e5
use proper namespacing
mcorino Nov 8, 2023
6ce71f9
remove empty headings
mcorino Nov 8, 2023
6787635
improve generated docs; add logo and version
mcorino Nov 8, 2023
78ebe74
improve doc layout
mcorino Nov 8, 2023
a888226
make PrinterDC platform dependent instead of explicitly excluded for …
mcorino Nov 9, 2023
b54f4f2
add missing 'override' decls
mcorino Nov 9, 2023
8aefdc5
fix Printer support requirements
mcorino Nov 9, 2023
b2c148b
fix missing splat
mcorino Nov 9, 2023
43cb8a3
fix requirements specs
mcorino Nov 9, 2023
a644457
add support for custom @wxrb_require YARD docu tag
mcorino Nov 10, 2023
0b0d1b2
add support for 'fulldocs' option and generation of class requirement…
mcorino Nov 10, 2023
a7ac5d0
add @wxrb_require tags
mcorino Nov 10, 2023
42646b7
various changes:
mcorino Nov 10, 2023
876ad3e
add missing template customization for logo+version
mcorino Nov 10, 2023
188f26c
revert kramdown markup for YARD (integration sucks)
mcorino Nov 10, 2023
f81e622
change inline note/remark gen and layout
mcorino Nov 10, 2023
5f633bb
include all feature dependent items for fulldocs
mcorino Nov 10, 2023
296f495
update for method name change
mcorino Nov 11, 2023
4672ea5
add support for feature dependent ignore specs
mcorino Nov 11, 2023
0d002ad
support doc only feature dependent ignore specs
mcorino Nov 11, 2023
4cfc1ac
allow for arrays
mcorino Nov 11, 2023
0dc23b6
move TaskBarButton etc. in seperate director; use ignore_unless
mcorino Nov 11, 2023
f896de2
use feature dependent ignores
mcorino Nov 11, 2023
4120335
improve doc
mcorino Nov 11, 2023
0254db4
do not wrap wxLogStream (creating a file logger in pure Ruby is trivial)
mcorino Nov 11, 2023
0dbc859
consistently use feature dependent ignore if appropriate
mcorino Nov 11, 2023
10823a4
add wxWidgets version to html doc
mcorino Nov 11, 2023
00c6503
build full docs for HTML
mcorino Nov 11, 2023
3c75291
update wxWidgets tag for builds
mcorino Nov 11, 2023
1afc180
fix linux wxGTK build
mcorino Nov 11, 2023
0c7d61a
fix incorrect attribute ref
mcorino Nov 12, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/workflows/linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
CC: gcc-9
CXX: g++-9
ruby: '2.5'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
configure_flags:
use_xvfb: true
Expand All @@ -61,7 +61,7 @@ jobs:
CC: gcc-10
CXX: g++-10
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
configure_flags:
use_xvfb: true
Expand All @@ -72,7 +72,7 @@ jobs:
CC: gcc-11
CXX: g++-11
ruby: '3.0'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
configure_flags:
use_xvfb: true
Expand All @@ -83,7 +83,7 @@ jobs:
CC: gcc-12
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
configure_flags:
use_xvfb: true
Expand All @@ -94,7 +94,7 @@ jobs:
CC: gcc-12
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
configure_flags:
use_xvfb: true
Expand All @@ -105,7 +105,7 @@ jobs:
CC: gcc-12
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
configure_flags:
use_xvfb: true
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/mac.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ jobs:
- name: wxMac macOS 11
runner: macos-11
arch: x86_64
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
ruby: '3.2'
swig: '4'
configure_flags: --disable-sys-libs
Expand All @@ -61,7 +61,7 @@ jobs:
- name: wxMac macOS 13
runner: macos-13
arch: x86_64
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
ruby: '3.2'
swig: '4'
configure_flags: --disable-sys-libs
Expand All @@ -70,7 +70,7 @@ jobs:
- name: wxMac macOS 13
runner: macos-13
arch: x86_64
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
ruby: '3.2'
swig: '4'
configure_flags: --disable-sys-libs
Expand All @@ -79,7 +79,7 @@ jobs:
- name: wxMac macOS 13
runner: macos-13
arch: x86_64
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
ruby: '3.2'
swig: '4'
configure_flags: --disable-sys-libs
Expand All @@ -88,7 +88,7 @@ jobs:
- name: wxMac macOS 13
runner: macos-13
arch: x86_64
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
ruby: '3.2'
swig: '4'
configure_flags: --disable-sys-libs
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/msw.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,39 +54,39 @@ jobs:
platform: 'x64'
CXX: g++-12
ruby: '2.7'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
wxw_type: embed
wxr_type: develop
- os: windows-2022
platform: 'x64'
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
wxw_type: embed
wxr_type: develop
- os: windows-2022
platform: 'x64'
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
wxw_type: develop
wxr_type: develop
- os: windows-2022
platform: 'x64'
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
wxw_type: embed
wxr_type: bingem
- os: windows-2022
platform: 'x64'
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
wxw_type: embed
wxr_type: gem
Expand Down
6 changes: 1 addition & 5 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ jobs:

- name: Generate wxRuby3 docs
run: |
BUILD_CMD="bundle exec rake doc"
BUILD_CMD="bundle exec rake doc WXRUBY_FULLDOCS=1"
/bin/bash -o pipefail -c "xvfb-run -a -s '-screen 0 1600x1200x24' $BUILD_CMD 2>&1 | tee -a gembuild.out" || rc=$?
if [ -n "$rc" ]; then
if fgrep -q '(core dumped)' gembuild.out; then
Expand All @@ -96,10 +96,6 @@ jobs:
run: |
bundle exec yardoc

- name: Copy assets into HTML output folder
run: |
cp -r assets rdoc

- name: Setup Pages
uses: actions/configure-pages@v3

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ jobs:
CC: gcc-12
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'
configure_flags:
use_xvfb: true
Expand Down Expand Up @@ -197,7 +197,7 @@ jobs:
- name: wxMac macOS 13
runner: macos-13
arch: x86_64
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
ruby: '3.2'
swig: '4'
configure_flags: --disable-sys-libs
Expand Down Expand Up @@ -294,7 +294,7 @@ jobs:
platform: 'x64'
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'

steps:
Expand Down Expand Up @@ -376,7 +376,7 @@ jobs:
platform: 'x64'
CXX: g++-12
ruby: '3.2'
wxWidgets: '3.2.2.1'
wxWidgets: '3.2.4'
swig: '4'

steps:
Expand Down
1 change: 1 addition & 0 deletions .yardopts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
--charset UTF-8
--markup markdown
--readme README.md
--asset assets
--title "wxRuby3 API Documentation"
--output-dir rdoc
--protected
Expand Down
12 changes: 6 additions & 6 deletions ext/wxruby3/include/wxruby-Config.h
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ class wxRbHashConfig : public wxConfigBase
}

#ifdef wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
virtual bool DoReadLongLong(const wxString& key, wxLongLong_t *pll) const
virtual bool DoReadLongLong(const wxString& key, wxLongLong_t *pll) const override
{
wxConfigPathChanger path(this, key);

Expand Down Expand Up @@ -487,7 +487,7 @@ class wxRbHashConfig : public wxConfigBase
}
#endif // wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG

virtual bool DoReadDouble(const wxString& key, double* val) const
virtual bool DoReadDouble(const wxString& key, double* val) const override
{
wxConfigPathChanger path(this, key);

Expand Down Expand Up @@ -517,7 +517,7 @@ class wxRbHashConfig : public wxConfigBase
}
}

virtual bool DoReadBool(const wxString& key, bool* val) const
virtual bool DoReadBool(const wxString& key, bool* val) const override
{
wxConfigPathChanger path(this, key);

Expand Down Expand Up @@ -637,7 +637,7 @@ class wxRbHashConfig : public wxConfigBase
}

#ifdef wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
virtual bool DoWriteLongLong(const wxString& key, wxLongLong_t value)
virtual bool DoWriteLongLong(const wxString& key, wxLongLong_t value) override
{
wxConfigPathChanger path(this, key);
wxString strName = path.Name();
Expand Down Expand Up @@ -675,7 +675,7 @@ class wxRbHashConfig : public wxConfigBase
}
#endif // wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG

virtual bool DoWriteDouble(const wxString& key, double value)
virtual bool DoWriteDouble(const wxString& key, double value) override
{
wxConfigPathChanger path(this, key);
wxString strName = path.Name();
Expand Down Expand Up @@ -712,7 +712,7 @@ class wxRbHashConfig : public wxConfigBase
return true;
}

virtual bool DoWriteBool(const wxString& key, bool value)
virtual bool DoWriteBool(const wxString& key, bool value) override
{
wxConfigPathChanger path(this, key);
wxString strName = path.Name();
Expand Down
86 changes: 48 additions & 38 deletions lib/wx/doc/app.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,42 +5,52 @@
# :startdoc:


class Wx::App

# Set the menu item id for the About menu item.
# Default is {Wx::ID_ABOUT}
# @param [Integer] id
def set_mac_about_menu_itemid(id) end
alias :mac_about_menu_itemid= :set_mac_about_menu_itemid

# Get the current menu item id for the About menu item.
# Default is {Wx::ID_ABOUT}
# @return [Integer]
def get_mac_about_menu_itemid(id) end
alias :mac_about_menu_itemid :get_mac_about_menu_itemid

# Set the menu item id for the Preferences menu item.
# Default is {Wx::ID_PREFERENCES}
# @param [Integer] id
def set_mac_preferences_menu_itemid(id) end
alias :mac_preferences_menu_itemid= :set_mac_preferences_menu_itemid

# Get the current menu item id for the Preferences menu item.
# Default is {Wx::ID_PREFERENCES}
# @return [Integer]
def get_mac_preferences_menu_itemid(id) end
alias :mac_preferences_menu_itemid :get_mac_preferences_menu_itemid

# Set the menu item id for the Exit menu item.
# Default is {Wx::ID_EXIT}
# @param [Integer] id
def set_mac_exit_menu_itemid(id) end
alias :mac_exit_menu_itemid= :set_mac_exit_menu_itemid

# Get the current menu item id for the Exit menu item.
# Default is {Wx::ID_EXIT}
# @return [Integer]
def get_mac_exit_menu_itemid(id) end
alias :mac_exit_menu_itemid :get_mac_exit_menu_itemid

module Wx

class App

# Set the menu item id for the About menu item.
# Default is {Wx::ID_ABOUT}
# @param [Integer] id
# @wxrb_require WXOSX
def set_mac_about_menu_itemid(id) end
alias :mac_about_menu_itemid= :set_mac_about_menu_itemid

# Get the current menu item id for the About menu item.
# Default is {Wx::ID_ABOUT}
# @return [Integer]
# @wxrb_require WXOSX
def get_mac_about_menu_itemid(id) end
alias :mac_about_menu_itemid :get_mac_about_menu_itemid

# Set the menu item id for the Preferences menu item.
# Default is {Wx::ID_PREFERENCES}
# @param [Integer] id
# @wxrb_require WXOSX
def set_mac_preferences_menu_itemid(id) end
alias :mac_preferences_menu_itemid= :set_mac_preferences_menu_itemid

# Get the current menu item id for the Preferences menu item.
# Default is {Wx::ID_PREFERENCES}
# @return [Integer]
# @wxrb_require WXOSX
def get_mac_preferences_menu_itemid(id) end
alias :mac_preferences_menu_itemid :get_mac_preferences_menu_itemid

# Set the menu item id for the Exit menu item.
# Default is {Wx::ID_EXIT}
# @param [Integer] id
# @wxrb_require WXOSX
def set_mac_exit_menu_itemid(id) end
alias :mac_exit_menu_itemid= :set_mac_exit_menu_itemid

# Get the current menu item id for the Exit menu item.
# Default is {Wx::ID_EXIT}
# @return [Integer]
# @wxrb_require WXOSX
def get_mac_exit_menu_itemid(id) end
alias :mac_exit_menu_itemid :get_mac_exit_menu_itemid

end

end
Loading