rdmenezes / crashrpt

Automatically exported from code.google.com/p/crashrpt
0 stars 0 forks source link

Documentation is out-dated #29

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
***NOTE*** Please do create a NEW issue per each detected bug! Do not list
all detected problems in single issue record!

What steps will reproduce the problem?
1. Install the exception handler with InstallW, as guided in the CrashRpt
v1.0 Documentation.
2. Trigger an exception.
3. Run the output program.

What is the expected output? What do you see instead?
The report window pops up.
CrashSender.exe crashes.

What version of the product are you using? On what operating system?
1.2.2, Windows 7.

Please provide any additional information below.
crashrpt works OK if I switch to install the exception handler with
CrAutoInstallHelper, as what crashrpttest does. Another proof of InstallW's
obsoleteness is in CrashRptTest.cpp, where the calling of Install() is
guarded by a preprocessor TEST_DEPRECATED_FUNCS. Seems the documentation
really needs update.

Original issue reported on code.google.com by crendk...@gmail.com on 7 Apr 2010 at 12:48

GoogleCodeExporter commented 9 years ago
The CrashRpt_v1.0_Documentation wiki page shouldn't be used if you use the 
latest
version of CrashRpt. This wiki page is useful if you use the oldest CrashRpt 
v1.0.

If you need the up-to-date documentation, please follow to
http://crashrpt.sourceforge.net

Original comment by zexspect...@gmail.com on 8 Apr 2010 at 7:21

GoogleCodeExporter commented 9 years ago
I see "Online Documentation" link in the project home now. Unlucky me I did not 
see
that at first. If there is no such "v1.0 Documentation" in the wiki, I may pay 
more
attention. My fault.

Is there any reason people should use crashrpt 1.0?

Original comment by crendk...@gmail.com on 8 Apr 2010 at 11:22

GoogleCodeExporter commented 9 years ago
CrashRpt 1.0 is deprecated. It is not recommended to use.

The real issue is  that Install() function didn't work. This will be fixed in 
v1.2.3
(probably will be released this month).

Original comment by zexspect...@gmail.com on 9 Apr 2010 at 5:40

GoogleCodeExporter commented 9 years ago
Then there is also no reason for people to read "v1.0 Documentation". How about
removing it or marking it "Deprecated" for less confusion?

Original comment by crendk...@gmail.com on 9 Apr 2010 at 6:47

GoogleCodeExporter commented 9 years ago
The Install() function works in v1.2.3. I also marked the v1.0 Documentation 
page as
obsolete to avoid confusion. I think this should be enough.

Original comment by zexspect...@gmail.com on 12 Apr 2010 at 11:17