Problem 549 - Software reference manual is incomplete
Summary: Software reference manual is incomplete
Status: RESOLVED INVALID
Alias: None
Product: Documentation
Classification: Unclassified
Component: Software Reference Manual (show other problems)
Version: 5.2
Hardware: All Other
: P2 normal
Assignee: Serguei.Sadilov
URL:
Depends on:
Blocks:
 
Reported: 2003-10-28 09:34 CET by pavol
Modified: 2007-04-08 18:52 CEST (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this problem.
Description pavol 2003-10-28 09:34:21 CET 
Hi,

Please produce the complete software reference manual, or give us the posibility
to browse the source code with some Web tool. I know, that sources are public,
but I think it makes no sense that everybody should keep running the browsing
tool on private copy of the source codes.

The "Software Reference Manual" web page
(http://pcitapiww.cern.ch/asdcgi/geant4/SRM/G4GenDoc.csh)
is generating only small subset of available public members of the classes.

One example - for the G4VSensitiveDetector class the web page
tells you nothing about the following existing public methods:
G4int  GetNumberOfCollections()
G4String GetCollectionName(G4int id)
void SetVerboseLevel(G4int vl)
void Activate(G4bool activeFlag)
G4bool isActive()
G4String GetName()
G4String GetPathName()
G4String GetFullPathName()
G4VReadOutGeometry* GetROgeometry()

                    Pavol Strizenec
Comment 1 Gabriele Cosmo 2004-02-17 09:03:59 CET 
You can access to the LXR page for browsing the source.
The link is available from the G4 web site:
   http://www-geant4.kek.jp/lxr/source
As for the Software Reference Manual, it may be true that for some classes not
all defined methods (also public) are shown. However, in most cases this is
done intentional to put emphasis only on the relevant services provided by
a class.