[Gambas-bugtracker] Bug #2330: In A module or class that can be a function, Display _Call interface

bugtracker at gambaswiki.org bugtracker at gambaswiki.org
Fri Jul 30 00:40:31 CEST 2021


http://gambaswiki.org/bugtracker/edit?object=BUG.2330&from=L21haW4-

Brian G reported a new bug.

Summary
-------

In A module or class that can be a function, Display _Call interface

Type             : Request
Priority         : Medium
Gambas version   : Master
Product          : Development Environment


Description
-----------

Would it be possible in the automatically generated document for a component when a module or class can be a function,
have the help system include the information for that call interface 

Doing this in the same way it generates the information for every other public function in the module or file.
This  would be so helpful in help for people to know how to call the class or module as a function.
Clicking the function link in the line 'This class can be used as a function.'
Is not very intuitive. and it displays as _Call.... which can also be confusing to an uneducated user.

eg 

if MyClass class has help info such

--------------------------------------------------------------------
''' This is a special class\
''' It will do as defined

Export

'' This interface will return\
'' data
Public Sub _Call(text as string,...) as string
   print text
end
---------------------------------------------------------------

Right now the automatically generated help looks like:

--------------------------------------------------------------------
This is a special class 
It Will do as defined

This class is static.
This class can be used as a function.
--------------------------------------------------------------------

Is it possible to have it's help displayed by replacing the _Call with the Class or Module name:
And including the '' help info and function definition. Or list it as a method by the Class or module name.


-----------------------------------------------------------------------
This is a special class 
It Will do as defined

Public Function MyClass( text As String ) As String 

The interface will return
data

This class is static.
This class can be used as a function.
--------------------------------------------------------------------------


System information
------------------

[System]
Gambas=3.16.90 e08d47dd0 (master)
OperatingSystem=Linux
Kernel=5.11.0-25-generic
Architecture=x86_64
Distribution=Linux Mint 20.1 Ulyssa
Desktop=MATE
Font=Ubuntu,10
Scale=7
Theme=mint-y
Language=en_US.UTF-8
Memory=14011M

[Libraries]
Cairo=libcairo.so.2.11600.0
Curl=libcurl.so.4.6.0
DBus=libdbus-1.so.3.19.11
GDK2=libgdk-x11-2.0.so.0.2400.32
GDK3=libgdk-3.so.0.2404.16
GStreamer=libgstreamer-1.0.so.0.1602.0
GTK+2=libgtk-x11-2.0.so.0.2400.32
GTK+3=libgtk-3.so.0.2404.16
OpenGL=libGL.so.1.7.0
Poppler=libpoppler.so.97.0.0
QT5=libQt5Core.so.5.12.8
SDL=libSDL-1.2.so.0.11.4
SQLite=libsqlite3.so.0.8.6

[Environment]
CLUTTER_BACKEND=x11
COMPIZ_CONFIG_PROFILE=mint
DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus
DESKTOP_SESSION=mate
DISPLAY=:0
EDITOR=/usr/bin/nano
GB_GUI=gb.gtk3
GDMSESSION=mate
GDM_LANG=en_US
GIO_LAUNCHED_DESKTOP_FILE_PID=848801
GPG_AGENT_INFO=/run/user/1000/gnupg/S.gpg-agent:0:1
GTK3_MODULES=xapp-gtk3-module
GTK_MODULES=gail:atk-bridge
GTK_OVERLAY_SCROLLING=0
HOME=<home>
LANG=en_US.UTF-8
LANGUAGE=en_US.UTF-8
LC_ALL=en_US.UTF-8
LOGNAME=<user>
MATE_DESKTOP_SESSION_ID=this-is-deprecated
PATH=<home>/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
PWD=<home>
QT_ACCESSIBILITY=1
QT_AUTO_SCREEN_SCALE_FACTOR=0
QT_LOGGING_RULES=*.debug=false
QT_QPA_PLATFORMTHEME=qt5ct
QT_SCALE_FACTOR=1
SESSION_MANAGER=local/<hostname>:@/tmp/.ICE-unix/312652,unix/<hostname>:/tmp/.ICE-unix/312652
SHELL=/usr/bin/gsh
SHLVL=0
SSH_AGENT_PID=312788
SSH_AUTH_SOCK=/run/user/1000/keyring/ssh
TERM=xterm
TZ=:/etc/localtime
USER=<user>
XAUTHORITY=<home>/.Xauthority
XDG_CONFIG_DIRS=/etc/xdg/xdg-mate:/etc/xdg
XDG_CURRENT_DESKTOP=MATE
XDG_DATA_DIRS=/usr/share/mate:<home>/.local/share/flatpak/exports/share:/var/lib/flatpak/exports/share:/usr/local/share:/usr/share
XDG_GREETER_DATA_DIR=/var/lib/lightdm-data/<user>
XDG_RUNTIME_DIR=/run/user/1000
XDG_SEAT=seat0
XDG_SEAT_PATH=/org/freedesktop/DisplayManager/Seat0
XDG_SESSION_CLASS=user
XDG_SESSION_DESKTOP=mate
XDG_SESSION_ID=c4
XDG_SESSION_PATH=/org/freedesktop/DisplayManager/Session1
XDG_SESSION_TYPE=x11
XDG_VTNR=7




More information about the Bugtracker mailing list